Skip to main content
GET
/
v1
/
analytics
/
events
/
summary
Aggregated events (count + revenue)
curl --request GET \
  --url https://api.scribe-mail.com/v1/analytics/events/summary \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "label": "<string>",
      "count": 123,
      "value": 123
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total_count": 123,
    "total_pages": 123,
    "has_more": true
  }
}

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
​
group_by
enum<string>
Available options:
name,
signature_template,
marketing_campaign,
teammate,
anchor,
country,
currency,
user
​
start_date
string
​
end_date
string
​
name
string
​
currency
string
​
order_by
enum<string>
Available options:
count,
value
​
order
enum<string>
Available options:
asc,
desc
​
limit
integer
​
page
integer

Response

200 - application/json

Breakdown by group_by (revenue by name)

​
data
object[]
required
​
pagination
object
required

Offset (page/limit) pagination. The single pagination shape returned by every paginated list endpoint in the public API.