GET site/get_sessions_actions

Summary

This API request returns the following results at a site level when you choose a start date and an end date:

site_id: your site_id in UserIQ

summary_date: date for the summary

count_actions: total actions for that time period

count_sessions: total sessions for that time period

name: name of the site

Resource URL
https://api.useriq.com/api/1.0/site/get_sessions_actions

Resource Information
Request Type: GET
Response Format: JSON

Headers

useriq-api-key (required): Your valid API key generated from the Site settings page

Parameters

start_date - The beginning date to get site-wide actions/sessions. DEFAULT: today
end_date - The end date to get site-wide actions/sessions. DEFAULT: today

Example Request:

HTTP

curl \
 -H "Content-type: application/json" \
 -H "useriq-api-key: 572d7372829a3211a73d9c2cb790ffe3" \
 https://api.useriq.com/api/1.0/site/get_sessions_actions

Example Result

{
 "results":[
 {"site_id":####,"summary_date":"2018-10-01","count_actions":1000,"count_sessions":100,"name":"My Site"},
 {"site_id":####,"summary_date":"2018-10-02","count_actions":1000,"count_sessions":100,"name":"My Site"},
 { ... }
 ]
}

Response Codes
200: OK. Request processed successfully
400: Bad Request. API request could not be understood by the server.
401: Unauthorized. Invalid API access token.

Articles in this section

Comments