Revenue Product Segments

The Revenue Product Segments API provides access to detailed revenue data broken down by individual products. This enables investors and analysts to gain deeper insights into a company’s performance across its product portfolio.

POST /v1/company-revenue-product-segments/query

Revenue Product Segments

cURL

curl --request POST \
  --url https://api.bigdata.com/v1/company-revenue-product-segments/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "identifier": {
    "type": "rp_entity_id",
    "value": "<string>"
  },
  "period": "quarter"
}
'

200

{
  "results": {
    "rp_entity_id": "<string>",
    "target_identifier_id": "<string>",
    "fields": [
      "FISCAL_YEAR"
    ],
    "values": [
      [
        123,
        "<string>",
        "<string>",
        {}
      ]
    ]
  },
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

identifier · SingleIdentifier · object · required

Object specifying which identifier you are using to request the company revenue product data. You must supply one type and its corresponding value.

Show child attributes

Example:

{ "type": "rp_entity_id", "value": "4A6F00" }

period · enum<string> · default: quarter

Select whether the company revenue product data to be provided are on an annual or quarterly basis.

Available options: annual, quarter

Example:

"annual"

Response

200 - application/json

Successful Response

results · CompanyRevenueProduct · object · required

CompanyRevenueProduct

Results

Show child attributes

errors · ErrorDetail · object[] | null

Show child attributes

metadata · Metadata · object

Show child attributes