Performance

Get grouped page metrics

Changed on
get/performance/page-metrics

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/performance/page-metrics
  • Auth: HTTP bearer

Query parameters

start_datestring required

Start date in format YYYY-MM-DDTHH:MM:SSZ

end_datestring required

End date in format YYYY-MM-DDTHH:MM:SSZ

project_idinteger required

Project ID or slug

environment_idinteger

Environment ID (optional)

deployment_idinteger

Deployment ID (optional)

group_bystring required

Group by: path, country, region, city, device_type, browser, operating_system

device_typestring

Device type filter: desktop or mobile (optional)

include_botsboolean

Include crawler/datacenter bot samples (default false)

filter_pathstring

Filter to one page pathname, exact match (optional). path is accepted as an alias.

filter_countrystring

Filter to one country (optional)

filter_regionstring

Filter to one region (optional)

filter_citystring

Filter to one city (optional)

filter_browserstring

Filter to one browser (optional)

filter_operating_systemstring

Filter to one operating system (optional)

Response

Successfully retrieved grouped page metrics

grouped_bystring required
total_eventsinteger required

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status