Fetch an app's health overview instances plot
/apps/{id}/health/plots/instancesFetch an app's health overview instances plot, optionally narrowed by a filter expression over the app version. The response is a time series of three metrics bucketed by datetime: sessions, crashes (fatal exceptions) & ANRs.
from & to will default to a last 7 days time range if not
supplied. timezone is required and decides which day a bucket falls
in.
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 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
App's UUID.
uuidQuery Parameters
ISO 8601 UTC string in milliseconds precision. Example: 2023-11-01T18:30:00.000Z. Omitting both from and to returns the last seven days.
ISO 8601 UTC string in milliseconds precision. Example: 2023-11-01T18:30:00.000Z. Omitting both from and to returns the last seven days.
IANA timezone used to bucket and format datetime values in the response. Example: Asia/Kolkata.
Time bucket used for plot aggregation. Defaults to days.
Value in
- "minutes"
- "hours"
- "days"
- "months"
Conditions joined by AND or OR and grouped with parentheses,
each reading key:operator:values with the names
/apps/{id}/filters/keys publishes. AND binds tighter than OR.
version_name:in:[1.2.0,1.1.9] AND mapping_type:not_in:jsbundle(version_name:contains:SNAPSHOT AND mapping_type:in:proguard) OR patch_id:is_setAn operator taking no values ends its condition, as
patch_id:is_set does. Double-quote a value holding a space,
comma, bracket, colon or quote, with \" and \\ inside.
At most 4096 bytes, 32 conditions, 4 levels of nesting and 200 values in one condition.
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 } ] }]Think this page can be better?
Open an issue