Tenant Reports / Phygrid Developers

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

Method	Endpoint	Description
GET	events	Returns list of tenant events based on specified query parameters
GET	sessions	Returns list of tenant sessions based on specified query parameters
GET	nps	Returns tenant nps data
GET	events flow	Returns tenant events flow data
GET	products events	Returns list of tenant products events based on specified query parameters
GET	categories events	Returns list of tenant categories events based on specified query parameters
GET	purchases events	Returns list of tenant purchases (transactions) events based on specified query parameters
GET	purchased products events	Returns list of tenant purchased products events based on specified query parameters
GET	qr codes events	Returns list of tenant qr codes events based on specified query parameters
GET	media events	Returns list of tenant media events based on specified query parameters

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

GET Tenant events

Returns list of tenant events based on specified query parameters.

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

Response

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

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true
interactionType	string	Defines events interaction type. Possible values: `interactive, nonInteractive, all`. Default value: `all`	interactive	false
timespanType	string	Defines events timespan type. Possible values: `day, hour`. Default value: `day`	day	false

GET Tenant sessions

Returns list of tenant sessions based on specified query parameters.

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

Response

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

Query Parameters

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

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true
interactionType	string	Defines sessions interaction type. Possible values: `interactive, all`. Default value: `all`	interactive	false
timespanType	string	Defines sessions timespan type. Possible values: `day, hour`. Default value: `day`	day	false

GET Tenant nps

Returns tenant nps data

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

Response

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

Query Parameters

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

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true

GET Tenant events flow

Returns tenant events flow data.

GET {base-url}/v2/report/tenants/{tenant-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.

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true
eventsFlowDepth	number	Defines events flow depth. Minimum value: `1`. Maximum value: `40`. Default value: `15`	15	false

GET Tenant products events

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

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

Response

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

Query Parameters

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

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true
interactionType	string	Defines events interaction type. Possible values: `interactive`, `nonInteractive`, `all`. Default value: `all`	interactive	false

GET Tenant categories events

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

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

Response

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

Query Parameters

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

Parameter	Type	Description	Example	Required
`dateFrom`	`string`	Defines the starting date	`2022-12-26`	`true`
`dateTo`	`string`	Defines the final date	`2023-01-02`	`true`

GET Tenant purchases events

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

GET {base-url}/v2/report/tenants/{tenant-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;
  }
]

Query Parameters

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

Parameter	Type	Description	Example	Required
`dateFrom`	`string`	Defines the starting date	`2022-12-26`	`true`
`dateTo`	`string`	Defines the final date	`2023-01-02`	`true`

GET Tenant purchased products events

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

GET {base-url}/v2/report/tenants/{tenant-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;
  }
]

Query Parameters

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

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true

GET Tenant qr codes events

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

GET {base-url}/v2/report/tenants/{tenant-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;
  }
]

Query Parameters

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

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true

GET Tenant media events

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

GET {base-url}/v2/report/tenants/{tenant-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;
  }
]

Query Parameters

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

Parameter	Type	Description	Example	Required
dateFrom	string	Defines the starting date	2022-12-26	true
dateTo	string	Defines the final date	2023-01-02	true