Skip to Content
ReferenceAPI referenceAnalytics

Get the traffic summary for a time range

GET
/api/v1/analytics/summary

Returns request, byte, status class, latency and geo event totals for the range. With comparePrevious it adds the period of the same length that ends just before startDate, which stays null unless the range and that period each have requests or geo events. Ranges over 24 hours read the hourly aggregates, or the daily ones above 30 days. Those reads count whole hours or UTC days, from the one that holds startDate through the last one that starts before endDate. The unique IP and country counts are then estimates, and /api/v1/analytics/live-summary gives exact figures.

Authorization

cookiesession<token>

Session cookie authentication.

Query Parameters

startDate?|

Start of the range, inclusive, as ISO 8601 with a timezone, such as 2026-11-01T00:00:00Z. Requires endDate; omit with window.

endDate?|

End of the range, exclusive, as ISO 8601 with a timezone, such as 2026-11-02T00:00:00Z. Requires startDate; omit with window.

window?|

A rolling window ending now, such as 15m, 24h or 7d, up to 365 days. Use positive whole minutes, hours or days. Cannot be combined with explicit time bounds.

comparePrevious?boolean

Also return the period of the same length just before the range, and the percent change from it. Defaults to false.

Defaultfalse

Response Body

Request fulfilled, document follows

application/json
  1. response

Totals for a time range, and optionally for the period of the same length before it.

currentPeriod*

Request and geo event totals for one period.

Request times are in seconds over the requests timedRequests counts, and null when it is 0.

endDate*string

The request's endDate, echoed as ISO 8601.

percentChanges?|

Null whenever previousPeriod is null.

previousPeriod?|

Null unless comparePrevious is true and the range and the previous period each have requests or geo events.

startDate*string

The request's startDate, echoed as ISO 8601.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/analytics/summary?startDate=2026-11-01T00%3A00%3A00Z&endDate=2026-11-02T00%3A00%3A00Z'
Example Response
{  "currentPeriod": {    "avgBytesPerRequest": 0,    "avgRequestTime": 0,    "errorRate": 0,    "malformedRequests": 0,    "maxRequestTime": 0,    "status2xx": 0,    "status3xx": 0,    "status4xx": 0,    "status5xx": 0,    "timedRequests": 0,    "totalBytesSent": 0,    "totalGeoEvents": 0,    "totalRequests": 0,    "uniqueCountries": 0,    "uniqueIps": 0  },  "endDate": "string",  "percentChanges": {    "avgRequestTime": 0,    "bytesSent": 0,    "errorRate": 0,    "geoRecords": 0,    "logRecords": 0,    "malformedRate": 0,    "uniqueIps": 0  },  "previousPeriod": {    "avgBytesPerRequest": 0,    "avgRequestTime": 0,    "errorRate": 0,    "malformedRequests": 0,    "maxRequestTime": 0,    "status2xx": 0,    "status3xx": 0,    "status4xx": 0,    "status5xx": 0,    "timedRequests": 0,    "totalBytesSent": 0,    "totalGeoEvents": 0,    "totalRequests": 0,    "uniqueCountries": 0,    "uniqueIps": 0  },  "startDate": "string"}