Skip to content
/
Spend

Spend

Request

Returns spend data about the specified company.

It's also possible to specify what fields from the API should be returned. By default, only some fields are returned.

Security
authorization
Bodyapplication/jsonrequired

Company Spend Request

fieldsArray of strings(CompanySpendsSelectFields)

A list of data points to be returned in the API response.

Default:["company_id","spend","category_id","country_code"]
filtersobject(CompanySpendFilters)required

Filters for company spend data. Must provide either company_id OR company_ids, but not both.

Example:
{
  "category_ids": [
    "03B36D42E7F8E60BE58BA4356B6AF40C",
    "3B7D551F81A8A448041BF23C85E3D21B"
  ],
  "company_id": "1698C53EBC888758570396E0334965C1"
}
limitinteger, <= 1000(Limit)

The number of records to return in the request.

Default:10
offsetinteger, >= 0(Offset)

Used for paginating records.

Default:0
sortsArray of objects(CompanySpendSorts)
Example:
[
  {
    "direction": "DESC",
    "field": "spend"
  }
]
POST
/data-api/v1/company/spend
curl -i -X POST \
  https://api.hginsights.com/data-api/v1/company/spend \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fields": [
      "company_id",
      "spend",
      "category_id",
      "country_code"
    ],
    "filters": {
      "category_ids": [
        "03B36D42E7F8E60BE58BA4356B6AF40C",
        "3B7D551F81A8A448041BF23C85E3D21B"
      ],
      "company_id": "1698C53EBC888758570396E0334965C1"
    },
    "limit": 10,
    "offset": 0,
    "sorts": [
      {
        "direction": "DESC",
        "field": "spend"
      }
    ]
  }'

Responses

Company Spend Response

Bodyapplication/json
countinteger
dataArray of objects(SpendObject)
Response
{
  "count": 0,
  "data": [
    { … }
  ]
}