Analytics

Logins

Retrieve aggregated guest logins for a Location

GET /api/get-social-logins

Auth [Identifier], Scope [Location]

Params

NameRequiredTypeDefaultComment
identifieryesstring
location_idyesinteger
from_dateyesstring
to_dateyesstring

Notes:

  • location_id The location_ids is either a single location_id integer or a comma separated list of location_ids
  • from_date The from_date format should be YYY-MM-DD
  • to_date The to_date format should be YYY-MM-DD
  • to_datefrom_date The range between the from_date to to_date cannot be greater than 60 days

Success [200]

{  
   "status":"success",
   "series":[  
      {  
         "name":"[Login Type]",
         "data":[  
            0,
            1,
            0,
            0,
            0,
            0,
            0,
            0
         ]
      }
   ],
   "categories":[  
      "2018-03-01",
      "2018-03-02",
      "2018-03-03",
      "2018-03-04",
      "2018-03-05",
      "2018-03-06",
      "2018-03-07",
      "2018-03-08"
   ]
}

Error [400]

{
"status": "error",
"message": {
        [error_msgs]
    }
}

Visits

Retrieve aggregated visit data for a Location

GET /api/get-visits

Auth [Identifier], Scope [Location]

Params

NameRequiredTypeDefaultComment
identifieryesstring
location_idyesinteger
from_dateyesstring
to_dateyesstring

Notes:

  • location_id The location_ids is either a single location_id integer or a comma separated list of location_ids
  • from_date The from_date format should be YYY-MM-DD
  • to_date The to_date format should be YYY-MM-DD
  • to_datefrom_date The range between the from_date to to_date cannot be greater than 60 days

Success [200]

{  
   "status":"success",
   "series":[  
      {  
         "name":"Visits",
         "data":[  
            0,
            1,
            0,
            0,
            0,
            0,
            0,
            0
         ]
      }
   ],
   "categories":[  
      "2018-03-01",
      "2018-03-02",
      "2018-03-03",
      "2018-03-04",
      "2018-03-05",
      "2018-03-06",
      "2018-03-07",
      "2018-03-08"
   ]
}

Error [400]

{
"status": "error",
"message": {
        [error_msgs]
    }
}