Click metrics

GET

/api/v2/channels/{{channel}}/letters/{letterUuid}/metrics/clicks

View the click metrics of a published letter, given its UUID. For each URL that has been clicked at lease once, we’ll return totals and uniques. These metrics aren’t real time, and they will update periodically throughout the day.

Authorizations

• bearerAuth

Parameters

Path Parameters

channel

required

string

letterUuid

required

string

Query Parameters

api

string

Example

false

When true, instructs the endpoint that you’re authenticating with an organization key as opposed to some other method. In almost all cases you will want to set this value to true. When false, you must provide a one-time use token.

Responses

200

Click metrics

Media type application/json

object

items

Array<object>

object

total

number

uniques

number

url

string

message

string

total

number

Examples

Example Click metrics

{
  "items": [
    {
      "total": 67,
      "uniques": 52,
      "url": "https://en.wikipedia.org/wiki/Tiger"
    },
    {
      "total": 49,
      "uniques": 36,
      "url": "https://en.wikipedia.org/wiki/Lion"
    },
    {
      "total": 40,
      "uniques": 30,
      "url": "https://en.wikipedia.org/wiki/Bear"
    }
  ],
  "message": "Do something kind today",
  "total": 3
}

Headers

Access-Control-Allow-Credentials

string

Example

true

Access-Control-Allow-Origin

string

Example

*

Access-Control-Max-Age

string

Example

86400

Cache-Control

string

Example

no-cache, private

Connection

string

Example

close

Date

string

Example

Mon, 11 Mar 2024 19:37:04 GMT

Host

string

Example

localhost:8000

X-Powered-By

string

Example

PHP/7.4.33