Reports

Get reached user data

Return records where users have logged in at least once in mobile or web. All records will be returned by page within a selected timeframe.

GET

/api/v1/analytics/reached

curl --request GET \
  --url 'https://voyager.korbyt.com/api/v1/analytics/reached?page_number=1&page_limit=10&start_date=1%2F1%2F2019&end_date=2%2F1%2F2023' \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

page_numberintegerqueryrequired

Current selected page

Example: 1

page_limitintegerqueryrequired

Number of records displayed on a page (Max 25)

Example: 10

start_datestringqueryrequired

Start date of record range

Example: 1/1/2019

end_datestringqueryrequired

End date of record range

Example: 2/1/2023

Response

Success. Response body is not documented in the source collection.

Still need help? Share an idea