Get audience overlap across all newsletters

GET

/api/v3/contacts/overlap

const url = 'https://api.tryletterhead.com/api/v3/contacts/overlap?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/contacts/overlap?api=true' \
  --header 'Authorization: Bearer <token>'

Returns a pairwise newsletter-overlap matrix across your company audience. For every pair of your newsletters it reports how many active subscribers the two share, and the diagonal carries each newsletter’s own active-subscriber total. Counts are deduplicated by email across your audience.

This is a company-level (v3) read. Authenticate with a company API key as a Bearer token.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Set to true.

Responses

200

200 OK

application/json

object

items

object

newsletters

One entry per newsletter — the matrix diagonal.

Array<object>

object

channel

The newsletter’s channel identifier (slug).

string

name

The newsletter’s display name.

string

activeSubscribers

The newsletter’s own active-subscriber total.

integer

overlaps

One entry per newsletter pair — the off-diagonal cells.

Array<object>

object

channels

The two newsletters in the pair, each as { channel, name }.

Array<object>

object

channel

string

name

string

sharedActiveSubscribers

Active subscribers shared by the pair.

integer

message

string

total

integer

Example

{
  "items": {
    "newsletters": [
      {
        "channel": "the-daily",
        "name": "The Daily",
        "activeSubscribers": 12400
      },
      {
        "channel": "weekend-reads",
        "name": "Weekend Reads",
        "activeSubscribers": 8800
      },
      {
        "channel": "product-updates",
        "name": "Product Updates",
        "activeSubscribers": 5300
      }
    ],
    "overlaps": [
      {
        "channels": [
          {
            "channel": "the-daily",
            "name": "The Daily"
          },
          {
            "channel": "weekend-reads",
            "name": "Weekend Reads"
          }
        ],
        "sharedActiveSubscribers": 3100
      },
      {
        "channels": [
          {
            "channel": "the-daily",
            "name": "The Daily"
          },
          {
            "channel": "product-updates",
            "name": "Product Updates"
          }
        ],
        "sharedActiveSubscribers": 1450
      },
      {
        "channels": [
          {
            "channel": "weekend-reads",
            "name": "Weekend Reads"
          },
          {
            "channel": "product-updates",
            "name": "Product Updates"
          }
        ],
        "sharedActiveSubscribers": 920
      }
    ]
  },
  "message": "Newsletter overlap matrix",
  "total": 1
}

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