Measure logo
REST API ReferenceDashboard APIApps

Fetch an app's health overview instances plot

GET/apps/{id}/health/plots/instances

Fetch an app's health overview instances plot. The response is a time series of three metrics bucketed by datetime: sessions, crashes (fatal exceptions) & ANRs. Filter time range using from & to query string parameters. Filter version using versions & version_codes query string parameters.

from & to will default to a last 7 days time range if not supplied. Both versions & version_codes should be present if any one of them is present, and must contain the same number of items. For multiple comma separated fields, make sure no whitespace characters exist before or after commas.

The response is an array of three series identified by id: sessions, crashes & anrs. Each series holds a sparse list of datetime buckets that had data, so a bucket with no crashes or ANRs is simply absent from that series.

Authorization

bearerAuth
AuthorizationBearer <token>

User access token issued at sign-in. Sent as Authorization: Bearer <access-token> unless cookies are used to send tokens. The /auth/refresh and /auth/signout endpoints expect the session's refresh token in the same header format instead.

In: header

Path Parameters

id*string

App's UUID.

Formatuuid

Query Parameters

from?string

ISO8601 timestamp to include data after this time.

to?string

ISO8601 timestamp to include data before this time.

timezone*string

IANA timezone used to bucket and format datetime values in the response.

plot_time_group?string

Time bucket used for plot aggregation. Accepted values: minutes, hours, days, months. Defaults to days.

Value in

  • "minutes"
  • "hours"
  • "days"
  • "months"
versions?string

List of comma separated app version identifier strings to return only matching data.

version_codes?string

List of comma separated app version codes to return only matching data.

filter_short_code?string

Code representing combination of filters.

Response Body

application/json

curl -X GET "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/health/plots/instances?timezone=string"
[  {    "id": "sessions",    "data": [      {        "datetime": "2024-10-02",        "instances": 12044      },      {        "datetime": "2024-10-03",        "instances": 13890      }    ]  },  {    "id": "crashes",    "data": [      {        "datetime": "2024-10-02",        "instances": 32      }    ]  },  {    "id": "anrs",    "data": [      {        "datetime": "2024-10-02",        "instances": 4      }    ]  }]
Empty
Empty
Empty
Empty
Empty

Think this page can be better?

Open an issue