App Reports

The following endpoints are available in the API for app reports.

{tenant-id} is your tenant id in the grid console.

{app-id} is your app id in the grid console.

GET App events

Returns list of app events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/events

Response

[
  {
    "id": string,
    "type": string,
    "tenantId": string,
    "appId": string,
    "date": string,
    "eventType": string,
    "interaction": boolean,
    "count": number,
    "sessionCount": number,
    "hour"?: number
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App sessions

Returns list of app sessions based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/sessions

Response

[
  {
    "id": string,
    "type": string,
    "tenantId": string,
    "sessionCount": number,
    "date": string,
    "appId": string,
    "hour"?: number
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App nps

Returns app nps data.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/nps

Response

{
  "score": number,
  "replyCount": number
}

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App events flow

Returns app events flow data.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/eventsFlow

Response

[
  {
    "count": number,
    "eventType": string,
    "eventTypePrevious"?: string,
    "eventOrder": number
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App products events

Returns list of app products events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/products

Response

[
  {
    "id": string,
    "type": string,
    "tenantId": string,
    "date": string,
    "eventType": string,
    "interaction": boolean,
    "productId": string,
    "count": number,
    "sessionCount": number,
    "appId": string
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App categories events

Returns list of app categories events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/categories

Response

[
  {
    "id": string,
    "type": string,
    "tenantId": string,
    "date": string,
    "eventType": string,
    "interaction": boolean,
    "categoryId": string,
    "count": number,
    "sessionCount": number,
    "appId": string
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App purchases events

Returns list of app purchases (transactions) events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/purchases

Response

[
  {
    id: string;
    type: string;
    tenantId: string;
    date: string;
    eventType: string;
    eventTime: string;
    interaction: boolean;
    transactionId: string;
    revenue: number;
    currency: string;
    count: number;
    sessionCount: number;
    appId: string;
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App purchased products events

Returns list of app purchased products events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/purchased-products

Response

[
  {
    id: string;
    type: string;
    tenantId: string;
    date: string;
    eventType: string;
    interaction: boolean;
    transactionId: string;
    productId: string;
    categoryId: string;
    productName: string;
    currency: string;
    quantity: number;
    price: number;
    count: number;
    sessionCount: number;
    appId: string;
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App qr codes events

Returns list of app qr codes events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/qr-codes

Response

[
  {
    id: string;
    type: string;
    tenantId: string;
    date: string;
    eventType: string;
    interaction: boolean;
    qrCodeId: string;
    qrCodeContent: string;
    qrCodeEntryMethod: string;
    qrCodeType: string;
    count: number;
    sessionCount: number;
    appId: string;
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.

GET App media events

Returns list of app media events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/apps/{app-id}/media

Response

[
  {
    id: string;
    type: string;
    tenantId: string;
    date: string;
    eventType: string;
    interaction: boolean;
    mediaId: string;
    mediaType: string;
    mediaName: string;
    mediaTags: string[];
    mediaDuration: number;
    count: number;
    sessionCount: number;
    appId: string;
  }
]

Query Parameters

To use query parameters, add them as GET properties to the URL.