Traffic breakdown by dimension
True pageview volume broken down by a single dimension — the source for Top Pages, Devices, Geo, and Sources reports. Reads raw events (not Core Web Vitals samples), so counts are honest traffic. Each row is { value, pageviews, unique_users, unique_sessions }, ordered by pageviews descending. value is an empty string when the dimension is not set on an event. pageviews always counts $pageview events regardless of event_type.
Segment scoping: pass segment_id (a segment created via the Segments API) to count only traffic from that segment's members — e.g. top pages read by customers, or by paid-search visitors:
GET /client/v1/data/events/breakdown?dimension=page&segment_id=9f4e...
curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/data/events/breakdown?location_id=example_string&date_from=2024-12-25&date_to=2024-12-25&dimension=page&event_type=example_string&segment_id=123e4567-e89b-12d3-a456-426614174000&limit=50" \
-H "Content-Type: application/json" \
-H "X-Location-Id: example_string" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/data/events/breakdown?location_id=example_string&date_from=2024-12-25&date_to=2024-12-25&dimension=page&event_type=example_string&segment_id=123e4567-e89b-12d3-a456-426614174000&limit=50"
headers = {
"Content-Type": "application/json",
"X-Location-Id": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/data/events/breakdown?location_id=example_string&date_from=2024-12-25&date_to=2024-12-25&dimension=page&event_type=example_string&segment_id=123e4567-e89b-12d3-a456-426614174000&limit=50", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Location-Id": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://mythic-analytics.gulp.workers.dev/client/v1/data/events/breakdown?location_id=example_string&date_from=2024-12-25&date_to=2024-12-25&dimension=page&event_type=example_string&segment_id=123e4567-e89b-12d3-a456-426614174000&limit=50", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Location-Id", "example_string")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://mythic-analytics.gulp.workers.dev/client/v1/data/events/breakdown?location_id=example_string&date_from=2024-12-25&date_to=2024-12-25&dimension=page&event_type=example_string&segment_id=123e4567-e89b-12d3-a456-426614174000&limit=50')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-Location-Id'] = 'example_string'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"success": true,
"data": [
{
"value": "/pricing",
"pageviews": 1240,
"unique_users": 830,
"unique_sessions": 910
}
],
"rows": 42
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
{
"error": "Error",
"message": "An upstream data service failed",
"code": 502
}
{
"error": "Service Unavailable",
"message": "The service is temporarily unavailable. Please try again later",
"code": 503
}
/events/breakdown
Target server for requests. Edit to use your own host.
Agency key (ak_) or location secret key (sk_) as a bearer token. Format: Bearer ak_... or Bearer sk_.... Scoped keys (mcp_) are accepted too and need the read scope of the family the route belongs to (people, events, sessions, replays, exceptions, heatmaps or bigquery_export). See Using an mcp_ key over HTTP.
ak_) or location secret key (sk_) as a bearer token. Format: Bearer ak_... or Bearer sk_.... Scoped keys (mcp_) are accepted too and need the read scope of the family the route belongs to (people, events, sessions, replays, exceptions, heatmaps or bigquery_export). See Using an mcp_ key over HTTP.
Alternative to the X-Location-Id header for agency (ak_) keys. Ignored for secret (sk_) keys.
Start date (YYYY-MM-DD).
End date (YYYY-MM-DD).
Dimension to group by. Defaults to page.
Filter to a single event type. Default counts all events.
Scope results to members of a saved segment (created via the Segments API). Two independent time filters apply: the segment decides WHICH PEOPLE qualify (a live definition, evaluated at query time — not stored membership), and date_from/date_to decides WHICH OF THEIR ROWS are returned. A person who qualifies today contributes all their sessions/events inside the date window — including ones unrelated to how they qualified; there is no "only rows from while they were a member". For first/last attribution scopes membership runs through the identity graph (a row counts when its distinct_id maps to a matching person); a segment with attribution: "session" instead matches visitors directly against the sessions store ("ever had a session that arrived via X"), with no identity-graph dependency. Composable with all other filters. Unknown or foreign id → 404 segment_not_found.
Max rows. Default 50, min 1, max 1000.
Location to scope the request to. Required for agency (ak_) keys on the event routes. Ignored for secret (sk_) keys, which resolve their own location, and not used by /export.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Agency key (ak_) or location secret key (sk_) as a bearer token. Format: Bearer ak_... or Bearer sk_.... Scoped keys (mcp_) are accepted too and need the read scope of the family the route belongs to (people, events, sessions, replays, exceptions, heatmaps or bigquery_export). See Using an mcp_ key over HTTP.
Query Parameters
Alternative to the X-Location-Id header for agency (ak_) keys. Ignored for secret (sk_) keys.
Start date (YYYY-MM-DD).
End date (YYYY-MM-DD).
Dimension to group by. Defaults to page.
pagepage_urlreferrerreferring_domaindevicebrowseroscountryutm_sourceutm_mediumutm_campaignutm_contentutm_termFilter to a single event type. Default counts all events.
Scope results to members of a saved segment (created via the Segments API). Two independent time filters apply: the segment decides WHICH PEOPLE qualify (a live definition, evaluated at query time — not stored membership), and date_from/date_to decides WHICH OF THEIR ROWS are returned. A person who qualifies today contributes all their sessions/events inside the date window — including ones unrelated to how they qualified; there is no "only rows from while they were a member". For first/last attribution scopes membership runs through the identity graph (a row counts when its distinct_id maps to a matching person); a segment with attribution: "session" instead matches visitors directly against the sessions store ("ever had a session that arrived via X"), with no identity-graph dependency. Composable with all other filters. Unknown or foreign id → 404 segment_not_found.
Max rows. Default 50, min 1, max 1000.
Headers
Location to scope the request to. Required for agency (ak_) keys on the event routes. Ignored for secret (sk_) keys, which resolve their own location, and not used by /export.
Responses
Number of rows returned.