version 8.3.8

Back | 

WsAnalyticsReport

Returns Analytics report for the given jobid

URL Format

/ws/ws_analytics_report/api/{app_token}/mode/json/apiv/5?jobid={jobid}

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.
jobid string jobid for the analytics report

Request Headers

Name
Authorization: Bearer {usertoken}

Possible Responses

  • 1272 Analytics job found
  • 102 Invalid app token

Example Response

{
  "response": {
    "success": {
      "code": 1272,
      "message": "Analytics job found",
      "details": ""
    },
    "WsAnalyticsReportResponse": {
      "report": {
        "id": "1",
        "status": "completed",
        "generationDate": "2019-11-07 09:29:00",
        "data": {
          "columns": [
            "yy",
            "mm",
            "dd",
            "project_uuid",
            "sessions",
            "plays",
            "project_title"
          ],
          "rows": [
            [
              2019,
              10,
              9,
              19,
              "r0os1lp2",
              1,
              3,
              "test project"
            ]
          ],
          "totalElements": "1"
        }
      }
    }
  }
}