Skip to main content
POST
/
v1
/
company-revenue-product-segments
/
query
Revenue Product Segments
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"
}
'
{
  "results": {
    "rp_entity_id": "<string>",
    "target_identifier_id": "<string>",
    "fields": [
      "FISCAL_YEAR"
    ],
    "values": [
      "<array>"
    ]
  },
  "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.

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
​
errors
ErrorDetail · object[] | null
​
metadata
Metadata · object