Documentation and GuidesAPI Reference
API Reference
Start typing to search…

Getting started

Authenticate

So you have an access key and a secret key, now what? You need to send it along with each request. You do this by setting the hs-auth header to apikey <access_key>:<secret_key> (replacing <access_key> and <secret_key> with your keys).

Hivestack uses API key authentication for securing access to our endpoints. Each request must include an API key, which can be provided in one of two ways:

  • Request Header: Set the hs-auth header to apikey <access_key>:<secret_key> (replacing <access_key> and <secret_key> with your keys)
  • Query Parameter: Alternatively, include the API key as the apikey query parameter.

To obtain your API key, please contact your Hivestack representative.

Version selection

To use version 2 of the DSP API, you must include the query string parameter version=2 in your requests. By default, the API will fallback to version 1.

⚠️

Important

Please note that version 1 is deprecated and will be removed in the future, so we encourage all users to
transition to version 2 to ensure continued support and access to the latest features.

Migration from version 1 to version 2

Deals API

Deal Object:

  • deal_category: A new field to indicate the type of deal. Possible Values include P (Publisher) and C (Curated).
  • seller_type: A new field to indicate the type of the organization (curator or publisher) that created the deal. Possible values are PUBLISHER (publisher organization) and INTERMEDIARY (curator organization).
  • media_owner_id: This field has been removed and replaced by seller_id.
  • media_owner_name: This field has been removed and replaced by seller_name.
  • start_from: Renamed to flight_from.
  • start_to: Renamed to flight_to.

Creative Submission API

CreativeGet Object

  • submitted_at: A new field to indicate when the creative was submitted, provided in Coordinated Universal Time (UTC). The format of the field follows the ISO 8601 format.
  • init: This field has been removed and replaced by submitted_at.
  • publisher_approvals: A new field that lists the publishers’ approval statuses for the creative.

Query String Parameters

  • publisherID: Renamed to publisher_id.
  • dealID: Renamed to deal_id.
  • initStart: Renamed to submitted_at_from.
  • initEnd: Renamed to submitted_at_to.