Create equity analysis

post

https://api.secondengine.com/{tenant}/analyses/equity

Create a new US/Canadian equity analysis.

Body Params

Create Analysis Dto

name

string

compares

array of objects

required

Associated item IDs to compare and their type

compares*

sortOrder

number

required

The order that this analysis should be displayed in

startDate

date

Defaults to 2020-03-28T04:00:00.000Z

The date that this portfolio analysis should start from, defaults to 5 years before end date. Format must be yyyy-MM-dd.

endDate

date

Defaults to 2025-02-28T23:57:32.750Z

The date that this portfolio analysis should end on, defaults to last day of previous month. Format must be yyyy-MM-dd.

isPreview

boolean

Defaults to false

Was this submission a quick preview?

keyPortfolioValue

number

Defaults to 100000

The amount of money this analysis is based on, defaults to $100,000

isAnalyzed

boolean

Defaults to true

Was the analysis done from the analyze page

countryOfListings

string

enum

Specifies if this is a us equity or canadian equity. Only for Equity analyzer

Allowed:

Responses

400

Bad Request.

401

Unauthorized.

403

Forbidden.

404

Not Found.

500

Internal Server Error.

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The record has been successfully created