Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Favorites

Create a favorite in a property for the user that is authorized

A favorite gives the ability to quick search their most wanted reports

Notes

  • There is not possible to have 2 ranks with the same value could not be duplicated.
  • The maximum numbers of reports to favorite is 12.
  • If a report is favorited in the rank 1 and there is already one report favorited in the rank 1, the latest one will be put in the desired and position and all the rest of the elements will be move one position
post/datainsights/v1.1/favorites

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

idinteger required

Favorite Id

rankinteger required

Rank associated to the favorite in order to display the reports

report_idinteger

Report, Stock Report or Hub Id favorited

entity_idinteger

Report, Stock Report or Hub Id favorited

report_kind'report' | 'stock_report' | 'hub'

Report Kind

kind'report' | 'stock_report' | 'hub'

Favorite Kind

Example request

{
  "id": 1,
  "report_kind": "stock_report",
  "kind": "stock_report"
}

Response

Created

idinteger required

Favorite Id

rankinteger required

Rank associated to the favorite in order to display the reports

report_idinteger

Report, Stock Report or Hub Id favorited

entity_idinteger

Report, Stock Report or Hub Id favorited

report_kind'report' | 'stock_report' | 'hub'

Report Kind

kind'report' | 'stock_report' | 'hub'

Favorite Kind

Example response

{
  "id": 1,
  "report_kind": "stock_report",
  "kind": "stock_report"
}