We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/traffic/keyword/describe

This API lists keyword groups available via /traffic/keyword. Because the available groups may vary depending on the requested fields, aggregation period and filters, this API can be useful for checking the available groups. Calling this API is much more efficient than calling /traffic/keyword. However, it might return false positives, that is groups that have no data and thus are not in the result set returned by /traffic/keyword.

The user must be authenticated and have read permissions to the given sites.

Current aggregation period and filter restrictions are the same as for /traffic/keyword:

Request

Identical to /traffic/event/describe.

Response

Identical to /traffic/event/describe.

Examples

Bash
$ python cx.py /traffic/keyword/describe '{"start":-3600,"siteIds":["12345"],"fields":["urls"]}'
{
 "start": 1416222066,
 "stop": 1416308466,
 "groups": [
 "cxd-intent",
 "acronym",
 "concept",
 "cxd-audience",
 "pageclass",
 "language",
 "taxonomy",
 "site",
 "cxd-categories",
 "person",
 "location",
 "company",
 "category",
 "entity"
 ]
}

Last updated: