Deal mapping

Returns additional information about your deals, such as the deal name and effective dates for each deal ID.

Response values

Parameter

Type

Description

deal_id

string

Provides the identifier for the deal, which is returned when you retrieve client audit logs. You declare the deal_id when setting up a deal in the Index UI.

internal_deal_id

integer

Provides the unique internal Index identifier for the deal.

deal_name

string

Provides the name that corresponds to the dealID.

dsp_id

integer

Provides the unique identifier for the DSP.

deal_type

integer

Specifies the ID for the deal type, where:
1 = one-to-many deals
0 = one-to-one deals

auction_type

string

Specifies the auction type for the deal, where:
first = first price auction
second = second price auction
fixed = fixed price auction

rate

float

Provides the floor rate for the deal, formatted two decimal places, for example 1.99.

section_id

array of integers

Provides the IDs of the deal sections associated with the deal.

status

string

Specifies the status of the deal, where:
A = active
D = deactivated or deleted
N = new

start_date

string

Provides the date the deal starts, formatted as YYYY-MM-DD.

end_date

string

Provides the date the deal ends, formatted as YYYY-MM-DD.

priority

integer

Provides the priority of the deal, formatted as a value between 1 (lowest priority) and 10 (highest priority).

Language