Get active engagement

GET

/api/v3/metrics/active-engagement

const url = 'https://api.tryletterhead.com/api/v3/metrics/active-engagement?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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.tryletterhead.com/api/v3/metrics/active-engagement?api=true' \
  --header 'Authorization: Bearer <token>'

Distinct-subscriber open and click counts across every channel under your company, over the trailing 30 days. Backs the goals page’s Active Readers and Active Clickers metrics.

v3 endpoints expect a company API key.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

Get active engagement

application/json

object

items

object

activeReaders

Distinct subscribers with at least one open in the trailing period.

integer

activeClickers

Distinct subscribers with at least one click in the trailing period.

integer

periodDays

Currently fixed at: 30.

integer

message

string

total

integer

Example

{
  "items": {
    "activeReaders": 3200,
    "activeClickers": 850,
    "periodDays": 30
  },
  "message": "Active engagement retrieved successfully.",
  "total": 1
}

Still can’t find what you need? Contact support.