/traffic/user/external | Documentation

This API aggregates the external information associated with the users. Such information must first be uploaded via /profile/user/external/update.

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

Current aggregation period and filter restrictions are as follows:

Period	Groups available	Fields available	Filters available	Notes
Last 31 days or less	All	`weight, events, uniqueUsers`	All
More than 31 days ago without long term storage	None	None	None	The data is unavailable for periods over 31 days, unless the sites are configured with long term support.
More than 31 days ago with long term storage	All	weight, events, uniqueUsers	All	The `explodeUsers` filter can be used only for a single site, i.e., when the number of sites is `1`.

Request

Identical to /traffic/event except that history aggregation (historyFields) is not supported and the only fields that can be aggregated are weight, events and uniqueUsers, where both weight and events are implicit and the uniqueUsers field has to be specified explicitly. See also example below.

The aggregated weight for an item is also referred to as its "attention score".

Response

Identical to /traffic/event except that each group also has an aggregated summary. See also example below.

Examples

Bash

$ python cx.py /traffic/user/external '{"siteId":"12345", "start":"-7d", "groups":["cxd-gender"], "fields":["uniqueUsers"]}'
{
 "start": 1415795853,
 "stop": 1416400653,
 "groups": [
 {
 "data": {
 "uniqueUsers": 10003,
 "events": 105001,
 "weight": 105014.0
 },
 "group": "cxd-gender",
 "items": [
 {
 "item": "male",
 "data": {
 "uniqueUsers": 5058,
 "events": 53078,
 "weight": 53078.0
 }
 },
 {
 "item": "female",
 "data": {
 "uniqueUsers": 4946,
 "events": 51936,
 "weight": 51936.0
 }
 }
 ]
 }
 ]
}

Last updated: November 12, 2024