Metrics

Overview

Returns all available metrics to be used in Reporting API.

Endpoint

Input

FieldTypeDescription
metrics

string[]

Metrics. If left empty, returns all available metrics.

Output

FieldTypeDescription
key

string

Metric identifier.
category

string

Metric category.
displayNamestringMetric name in the user interface.
displayFormatstringFormat of the returned metric value. Values like 'n0', 'n1' refers to how many digits after decimal point are returned.
descriptionstringMetric description.
specsMetadata[]Additional filtering possibilities for individual metric. If no value is specified the default metric is used.

JSON Sample

Request


        // To get a full list of metrics
{
    "metrics": [ ]
}

// To get data about specific metrics
{
    "metrics": ["clicks", "impressions"]
}
    

Response


        {
  "metricsMetadata": [
    {
      "key": "impressions",
      "displayName": "Impressions",
      "displayFormat": "n0",
      "description": "This metric shows the number of registered impressions for the selected dimension. An impression occurs when a user is exposed to an advertisement.",
      "specsMetadata": []
    },
    {
      "key": "clicks",
      "displayName": "Clicks",
      "displayFormat": "n0",
      "description": "This metric shows the number of clicks for the selected dimension.",
      "specsMetadata": []
    }
  ],
  "correlationCode": "ext_b23e67f7-34d9-4db8-a17e-bdc811436791"
}
    
Help

Still have questions?

If you can't find an answer to your question here, email our Support team