get
https://sandbox-api.viantinc.com/{basePath}/advertiser/getAllAdvertisers
Returns details about all of the Advertisers under the account.
Request
GET /advertiser/getAllAdvertisers
Response
| JSON Fields | Type | Description |
|---|---|---|
| messages | Object Array | An array of any error messages. |
| messages[].level | String | Error level. |
| messages[].code | String | Error code. |
| messages[].message | String | Error message. |
| entity | Object Array | An array of advertiser objects. |
| entity[].id | Number | Advertiser ID. |
| entity[].name | String | Advertiser name. |
| entity[].agencyId | Number | Agency ID to which the advertiser belongs. |
| entity[].currency | String | Currency displayed for pricing |
| entity[].category | String | Business category for advertiser See reference table in Advertiser summary |
| entity[].timezoneName | String | The abbreviation of the Advertiser’s time zone. |
| entity[].externalAdvertiserId | String | External ID for the Advertiser |
Example
Request
curl -u <user>:<password> https://sandbox-api.viant.com/v1/advertiser/getAllAdvertisers
Response
{
"messages": [],
"entity": [
{
"id": 456,
"name": "Old Advertiser",
"agencyId": 123,
"currency": "USD",
"category": "IAB1",
"timezoneName": "ET",
"externalAdvertiserId": "123#Test"
},
{
"id": 654,
"name": "New Advertiser",
"agencyId": 321,
"currency": "USD",
"category": "IAB1",
"timezoneName": "PT",
"externalAdvertiserId": "Abc!456"
}
]
}