Skip to content

Get key location metrics

Request

The method allows you to get the main indicators of the location for the selected period and compare with the previous period of the same duration

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Query
date_fromstring, (date)required

Start date of the analyzed period

date_tostring, (date)required

End date of the analyzed period (included in the report)

team_member_idinteger

ID of the location team member whose work needs to be analyzed

position_idinteger

location position ID to analyze the work of all team members belonging to the same position

user_idinteger

The user ID of the location whose work you want to analyze

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json
curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/{location_id}/analytics/overall?date_from=2019-08-24&date_to=2019-08-24&team_member_id=0&position_id=0&user_id=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Basic indicators

Bodyapplication/json
dataobject(analytics_report_overall_stats)required

Summary indicators

metaArray of objectsrequired

metadata

successbooleanrequired

Execution success status (true)

Response
{
  "data": {
    "income_total_stats": { … },
    "income_services_stats": { … },
    "income_goods_stats": { … },
    "income_average_stats": { … },
    "income_average_services_stats": { … },
    "fullness_stats": { … },
    "record_stats": { … },
    "client_stats": { … }
  },
  "meta": [
    {}
  ],
  "success": true
}