Documentation and GuidesAPI Reference
HomeDocumentation and GuidesAPI Reference
Keep this version as our default, as all of our definition IDs point to this
API Reference

Check avails for a targeting

post
https://apps.hivestack.com/api/v2/checkavailsbyunit

Returns the available impressions for a targeting. Users should use this endpoint to verify that we have enough available impressions for their impression goal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to false

When set to true, the goal will depend on the cadence. This means that the impression/budget will
be adjusted to reflect the cadence. Defaults to false.

Body Params

A payload containing the targeting

string
required

A date with the following format: YYYY-MM-DD.

string
required

An inclusive end date with the following format: YYYY-MM-DD.

integer

The ad duration in seconds. If omitted, we default to the targeted units' spot length.

targeting_criteria
object
required

A targeting object containing Hivestack IDs.

Response

Updated 9 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?