Skip to main content
GET
/
v1
/
analytics
/
clicks
Signature clicks (timeseries or breakdown)
curl --request GET \
  --url https://api.scribe-mail.com/v1/analytics/clicks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "period": "2023-11-07T05:31:56Z",
      "count": 123
    }
  ],
  "totals": {
    "count": 123
  },
  "time_zone": "<string>"
}

Authorizations

โ€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

โ€‹
granularity
enum<string>
Available options:
hour,
day,
week,
month

Response

200 - application/json

Timeseries (clicks projected)

โ€‹
data
object[]
required
โ€‹
totals
object
required
โ€‹
granularity
enum<string>
required
Available options:
hour,
day,
week,
month
โ€‹
time_zone
string
required