List bid models

get

https://{buzz_key}.api.beeswax.com/rest/v2/ref/bid-models

Retrieve a list of active bid models. Supports filtering, searching, and sorting to locate specific model types and attributes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

integer

Filter by ID (exact match).

id__in

array of integers

Multiple values may be separated by commas.

id__in

id__isempty

boolean

id__not

integer

id__not_in

array of integers

Multiple values may be separated by commas.

id__not_in

name

string

Filter by name (contains match).

name__contains

string

name__in

array of strings

Multiple values may be separated by commas.

name__in

name__isempty

boolean

name__not

string

name__not_contains

string

name__not_in

array of strings

Multiple values may be separated by commas.

name__not_in

order

string

Which field to use when ordering the results.

ordering

string

Ordering field, supports: update_date.

string

Search across name and value type.

value_type

string

Filter by value type (exact match).

value_type__in

array of strings

Multiple values may be separated by commas.

value_type__in

value_type__isempty

boolean

value_type__not

string

enum

Valid values are BID, MULTIPLIER, or BUDGET_WEIGHT. Determines whether the values in the Bid Model should be multiplied by the base bid at the Line Item level or used instead of that bid. BUDGET_WEIGHT should be used for Delivery Models.

BID - Bid
MULTIPLIER - Multiplier
BUDGET_WEIGHT - Budget Weight

Allowed:

value_type__not_in

array of strings

Multiple values may be separated by commas.

value_type__not_in

Responses

400

Invalid request parameters.

401

Authentication credentials were not provided.

403

Permission denied.

500

Internal server error.

200Bid models retrieved successfully.