Definitions

Below are a list of definitions that we use throughout the API documentation.

URL Parameters

channel_name

• channel_name is a string identifying the channel for which metrics are being requested - for example facebook.
• A list of possible channel_name values for a workspace can be found at the metrics channel list endpoint.

metric_id

• metric_id is the numerical signifier for a particular metric returned by a channel.
• A list of metrics for a channel with their corresponding IDs can be found at the metrics channel detail endpoint.

workspace_id

• workspace_id is the numerical signifier for a workspace.
• A list of accessible workspaces can be found at the workspace list endpoint.

Query Parameters

average

• average is a boolean flag passed to the metrics detail endpoint.
• Default: false

brands

• brands is a comma-separated list of brand IDs for which a metric is requested.
• A list of possible brands in a workspace can be found at the brand list endpoint.

end_date

• end_date is an ISO 8601 formatted date string (YYYY-MM-DD) representing the end of a date window over which a resource is requested.
• Note that end_date is inclusive - resources on that date will be included in the response.

format

• format is a string denoting the desired return format of the results.
• Default: json.
• Possible values: json, xml

groups

• groups is a comma-separated list of group IDs for which a metric is requested.
• A list of possible groups in a workspace can be found at the group list endpoint.

start_date

• start_date is an ISO 8601 formatted date string (YYYY-MM-DD) representing the beginning of a date window over which a resource is requested.
• Note that start_date is inclusive - resources on that date will be included in the response.

verbose

• verbose is a boolean flag passed to endpoints to return more detailed information about the resource.
• Default: false.

Terminology

derived metrics

• Derived Metrics are