Space Reports

Space reports

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

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

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

GET Space events

Returns list of space events based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-id}/events

Response

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

Returns list of space sessions based on specified query parameters.

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-id}/sessions

Response

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

Query Parameters

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

GET Space nps

Returns space nps data.

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-id}/nps

Response

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

Query Parameters

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

GET Space events flow

Returns space events flow data.

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-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 Space products events

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

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-id}/products

Response

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

Query Parameters

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

GET Space categories events

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

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-id}/categories

Response

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

Query Parameters

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

GET Space purchases events

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

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-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;
    spaceId: string;
  }
]

Query Parameters

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

GET Space purchased products events

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

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-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;
    spaceId: string;
  }
]

Query Parameters

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

GET Space qr codes events

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

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-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;
    spaceId: string;
  }
]

Query Parameters

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

GET Space media events

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

GET {base-url}/v2/report/tenants/{tenant-id}/spaces/{space-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;
    spaceId: string;
  }
]

Query Parameters

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