Measure logo
REST API ReferenceDashboard APISessions

Fetch an app's sessions instances plot

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

Fetch an app's sessions instances plot, optionally narrowed by a filter expression.

Sessions that contain only a session start event, with no other activity, are always excluded from the instance counts regardless of filters.

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

ISO 8601 UTC string in milliseconds precision. Example: 2023-11-01T18:30:00.000Z. Omitting both from and to returns the last seven days.

to?string

ISO 8601 UTC string in milliseconds precision. Example: 2023-11-01T18:30:00.000Z. Omitting both from and to returns the last seven days.

timezone*string

IANA timezone used to bucket and format datetime values in the response. Example: Asia/Kolkata.

plot_time_group?string

Time bucket used for plot aggregation. Defaults to days.

Value in

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

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_set

An 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/sessions/plots/instances?timezone=string"
[  {    "id": "1.0 (1)",    "data": [      {        "datetime": "2024-10-02",        "instances": 12      }    ]  }]

Think this page can be better?

Open an issue