publisher/advertiser/current-term
The advertiser current term resource allows a publisher to pull current terms from all joined advertisers.
If requesting a single program ID, the response will contain a single object.
If requesting all, the response will contain a paginated set of objects.
This API resource will only return results for Dynamic tracking advertisers.
GET | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Parameters | ||||||||||||||||||||||||||||||||||||||||||
Parameter | Description | Possible Values | Default | Required? | ||||||||||||||||||||||||||||||||||||||
programId | A single program ID | Valid integer | N/A | No | ||||||||||||||||||||||||||||||||||||||
Response Fields | ||||||||||||||||||||||||||||||||||||||||||
Field | Description | Notes | ||||||||||||||||||||||||||||||||||||||||
id | The id of the term | |||||||||||||||||||||||||||||||||||||||||
name | The name of the term | |||||||||||||||||||||||||||||||||||||||||
status | The status of the term | |||||||||||||||||||||||||||||||||||||||||
cookie_duration | The cookie duration in hours | |||||||||||||||||||||||||||||||||||||||||
click_payout | The CPC payout | |||||||||||||||||||||||||||||||||||||||||
payout[n] | Payout details | |||||||||||||||||||||||||||||||||||||||||
payout[n]level[id] | Payout level ID |
|
||||||||||||||||||||||||||||||||||||||||
payout[n]level[name] | Payout level name | |||||||||||||||||||||||||||||||||||||||||
payout[n]type | Payout type | one of: flat, percent | ||||||||||||||||||||||||||||||||||||||||
payout[n]payout | The payout value | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n] | The payout rules | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]name | The rule name | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]level[id] | The rule level ID |
|
||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]level[name] | The rule level name | |||||||||||||||||||||||||||||||||||||||||
payout[]rules[]action_type[id] | The ID of type of action taken |
|
||||||||||||||||||||||||||||||||||||||||
payout[]rules[]action_type[name] | The name of type of action taken | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]action_value | The value of the action taken | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]priority | The rule priority | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n] | Collection of conditions to trigger the rule | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n]type[id] | The condition type ID |
|
||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n]type[name] | The condition type name | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n]compare[id] | The comparison type ID |
|
||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n]compare[name] | The comparison type name | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n]values | A conditional set of values used for comparison | |||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n]lower | A conditional lower value used for comparison | Can be date or numeric | ||||||||||||||||||||||||||||||||||||||||
payout[n]rules[n]conditions[n]upper | A conditional upper value used for bound comparison (ie: between) | Can be date or numeric |