Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Location Analytics

Get all the trends of a client for a tenant or a site for a given time range.

This API provides the trends of visitors and passerby for a tenant across all the sites or for a specific site within the given time range.

get/network-services/v1/location-analytics/trends

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.

site-idstring const
Example:123682

ID of the site for which location analytics trends is requested.

Response

Object containing the location analytics trends.

idstring const required

Tenant ID or site ID.

typestring const required

Type of the analytics.

keysstring[]

List of the trends.

unitsstring[]

Units for the corresponding keys.

Example response

{
  "id": "1e2e0d38371f11ee82539ae66a6c36a2",
  "type": "/networking-services/location-analytics/trends",
  "keys": [
    "newVisitors",
    "recurringVisitors",
    "totalVisitors",
    "passerby",
    "visitDuration"
  ],
  "samples": [
    {
      "data": [
        30,
        20,
        50,
        70,
        200
      ],
      "timestamp": "1683284400000"
    },
    {
      "data": [
        12,
        45,
        57,
        90,
        500
      ],
      "timestamp": "1683284400000"
    }
  ],
  "units": [
    "count",
    "count",
    "count",
    "count",
    "minutes"
  ]
}