Dimensions

Overview

Returns all available dimensions to be used in Reporting Stats API.

Endpoint

Input

FieldTypeDescription
dimensions

string[]

Dimension. If left empty, returns all available dimensions.

Output

FieldTypeDescription
key

string

Dimension identifier.
displayNamestringDimension name in the user interface.
descriptionstringDimension description.

JSON Sample

Request


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

// To get data about specific dimensions
{
   "dimensions": ["publisher"]
}
    

Response


        {
   "dimensionsMetadata": [
    {
      "key": "publisher",
      "displayName": "Publisher",
      "description": "Groups data by publisher name."
    }
  ],
   "correlationCode": "ext_bd7d5c4f-5c47-421e-b93f-1f77b87b41dc" // unique code for developer reference
}
    
Help

Still have questions?

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