v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Location Analytics

Get the insights for each site of a tenant for a given time range.

This API provides the insights for each site of a tenant for a given time range.

get/network-services/v1/location-analytics/sites/insights

Query parameters

start-atstring const required

Start time in epoch for the location analytics trends/insights.

Example:1683284400000

Start time for the location analytics trends/insights.

end-atstring const required

End time in epoch for the location analytics trends/insights.

Example:1683284400000

End time for the location analytics trends/insights.

limitinteger

Example:20

Specifies the number of objects returned in a single page. Default: 20.

offsetinteger

Specifies the offset. Default: 0.

sortstring const

Example:totalVisitorCount ASC

Sorting can be supported on the following fields: totalVisitorCount, passerbyCount. Default: totalVisitorCount. Directions supported: ASC, DESC. Default: DESC.

Response

Object containing the location analytics insights for each site.

offsetinteger

Specifies the offset of the returned page.

countinteger

The number of objects returned in the current response.

totalinteger

The total number of objects contained in the database.

Example response

{
  "items": [
    {
      "id": "125424",
      "type": "/networking-services/location-analytics/sites/insights",
      "siteId": "125424",
      "siteName": "test-la-site-1",
      "newVisitorCount": 15,
      "recurringVisitorCount": 25,
      "totalVisitorCount": 40,
      "passerbyCount": 60,
      "visitDuration": 120
    },
    {
      "id": "783260",
      "type": "/networking-services/location-analytics/sites/insights",
      "siteId": "783260",
      "siteName": "test-la-site-2",
      "newVisitorCount": 15,
      "recurringVisitorCount": 25,
      "totalVisitorCount": 40,
      "passerbyCount": 60,
      "visitDuration": 120
    }
  ],
  "offset": 0,
  "count": 2,
  "total": 2
}