advertiser/term
The term resource allows an advertiser to create, retrieve, update, and delete terms for their program. Programs with itemized or basic tracking should use the itemized/basic tracking documentation. Programs with dynamic tracking should use the dynamic tracking documentation.
Itemized, Basic Tracking
| GET | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| id | The id, or comma-separated list of ids, of the term(s) you want to retrieve. If one id is provided, the resource object will be returned. If a comma-separated list of ids are provided, a list of objects will be returned. | * 987 OR 123,456,789 | N/A | No |
| Field | Description | Notes | ||
| Response Fields | ||||
| Field | Description | Notes | ||
| id | The id of the term | |||
| name | The name of the term | |||
| default | Boolean flag that indicates whether the term is default | |||
| cookie_duration | The duration our tracking software will honor the cookie | |||
| created | The date the term was created | |||
| assigned_publishers | The amount of publishers already assigned to the term. | |||
| pending_publishers | The amount of publishers pending to the term. | |||
| default_payout | The default payout of the term | |||
| payouts[n] | An array of payouts assigned to the term. | |||
| payouts[n][type] | The type of payout | flat, percent, cpc | ||
| payouts[n][payout] | The amount of the payout | |||
| payouts[n][product_list] | The itemized product list assigned to the payout | Only applicable to itemized programs | ||
| payouts[n][default] | Boolean flag that indicates whether the payout is default | Only applicable to itemized programs | ||
| payouts[n][tiers] | An array of tiers applicable to the parent payout | |||
| payouts[n][tiers][n][payout] | The payout amount of the tier | |||
| payouts[n][tiers][n][tier] | The threshold for giving the tiered payout | |||
| POST | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| N/A | ||||
| Post Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| name | The name of the term | * Any generic string | N/A | Yes |
| cookie_duration | The cookie duration in hours | * An integer | N/A | Yes |
| payouts[n] | An array of of payouts | N/A | Yes | |
| payouts[n][payout] | A floating point value used for the payout. At least one payout is needed for itemized programs. | payouts[n][payout]=5.000 | N/A | Yes |
| payouts[n][type] | A floating point value used for the payout. At least one payout is needed for itemized programs. | payouts[n][type]=flat OR payouts[n][type]=percent OR payouts[n][type]=cpc | N/A | Yes |
| payouts[n][default] | A floating point value used for the payout. At least one payout is needed for itemized programs. | payouts[n][default]=1 OR payouts[n][type]=0 | N/A | Yes |
| payouts[n][tiers][n] | An array of tiers for the parent payout | N/A | No | |
| payouts[n][tiers][n][payout] | The payout of the current tier | payouts[n][tiers][n][payout]=5.000 | N/A | Dependent on parent |
| payouts[n][tiers][n][tier] | The threshold for giving the tiered payout | payouts[n][tiers][n][payout]=50 | N/A | Dependent on parent |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
| DELETE | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| id | The id of the term being deleted | * 123 | N/A | Yes |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
* Values shown are placeholder values. Please replace with actual data.
Dynamic Tracking
| GET | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| id | The id, or comma-separated list of ids, of the term(s) you want to retrieve. If one id is provided, the resource object will be returned. If a comma-separated list of ids are provided, a list of objects will be returned. | * 987 OR 123,456,789 | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| id | The id of the term | |||
| name | The name of the term | |||
| default | Boolean flag that indicates whether the term is default | |||
| cookie_duration | The duration our tracking software will honor the cookie | |||
| created | The date the term was created | |||