Installation Reports

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

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

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

GET Installation events

Returns list of installation events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-id}/events

Response

[
  {
    "id": string,
    "type": string,
    "tenantId": string,
    "installationId": 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 Installation sessions

Returns list of installation sessions based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-id}/sessions

Response

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

Query Parameters

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

GET Installation nps

Returns installation nps data.

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-id}/nps

Response

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

Query Parameters

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

GET Installation events flow

Returns installation events flow data.

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-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 Installation products events

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

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-id}/products

Response

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

Query Parameters

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

GET Installation categories events

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

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-id}/categories

Response

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

Query Parameters

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

GET Installation monitoring events history

Returns list of grouped monitoring events

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-id}/monitoring

Response

[
  {
    "id": string,
    "eventType": string,
    "spaceId": string,
    "installationId": string,
    "deviceId": string,
    "str1": boolean,
    "str2": string,
    "history": Array<{
      int1: number;
      eventTime: string;
    }>
  }
]

Query Parameters

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

GET Installation purchases events

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

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-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;
    installationId: string;
  }
]

Query Parameters

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

GET Installation purchased products events

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

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-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;
    installationId: string;
  }
]

Query Parameters

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

GET Installation qr codes events

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

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-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;
    installationId: string;
  }
]

Query Parameters

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

GET Installation media events

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

GET {base-url}/v2/report/tenants/{tenant-id}/installations/{installation-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;
    installationId: string;
  }
]

Query Parameters

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