Get newsletter visits by region for the email/newsletter report

GET

/cms/analytics/email/visits-by-region

const url = 'https://api.example.com/cms/analytics/email/visits-by-region';
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/email/visits-by-region \
  --header 'API-Key: <API-Key>'

Visit counts by region for the selected channel(s) (combined if more than one).

Authorizations

ApiKeyAuth

Parameters

Query Parameters

date_from

string format: date

Defaults to 8 days ago.

date_to

string format: date

Defaults to today.

channel

Array<integer>

Responses

200

Visit counts per region

401

Admin authorization required

403

Insufficient permissions