Get performance detail for a single social channel

GET

/cms/analytics/social/{id}

const url = 'https://api.example.com/cms/analytics/social/1?export=1';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.example.com/cms/analytics/social/1?export=1' \
  --header 'API-Key: <API-Key>'

Requires both the /analytics/social permission and object-level access to the channel. Add export=1 to instead receive a CSV download.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

integer

Channel ID

Query Parameters

date_from

string format: date

Defaults to 7 days ago.

date_to

string format: date

Defaults to today.

export

string

Allowed values: 1

Set to 1 to receive a CSV download instead of JSON

Responses

200

Channel details and statistics, or a CSV file if export=1

400

Invalid date range

401

Admin authorization required

403

Insufficient permissions or no object access to this channel

404

Channel not found