AIairship
Reports

Web response report

Changed on

Get the web interaction data for the given app key. Accepts a required start time and optional end time and precision parameters.

get/api/reports/web/interaction

Request

Query parameters

app_keystring required
Example:YOUR_APP_KEY

The app key for your web project.

startstring date-time required
Example:2021-02-01T00:00:00

A date-time for start of report.

endstring date-time
Example:2021-02-28T00:00:00

A date-time for end of report.

precision'HOURLY' | 'DAILY' | 'MONTHLY'
Example:HOURLY

The precision of the report. Defaults to HOURLY.

Response

Returned on success, with the JSON representation of the web data in the body of the response.

app_keystring

The app key for the application.

endstring date-time

The end date-time for the report.

precision'HOURLY' | 'DAILY' | 'MONTHLY'

The precision of the report.

startstring date-time

The start date-time for the report.

Example response

{
  "app_key": "your_app_key",
  "end": "2018-06-02 10:00:00",
  "precision": "HOURLY",
  "start": "2018-06-01 10:00:00",
  "total_counts": [
    {
      "counts": {
        "clicks": 5,
        "sessions": 9
      },
      "date": "2018-06-02 10:00:00"
    }
  ]
}

Changes

  • e2bd980cb50bRevision changes
    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status

  • 3304568aaadcRevision changes
    • breaking

      for the query request parameter precision, default value DAILY was removed

    • breaking

      for the query request parameter end, the format changed from no format to date-time

    • breaking

      for the query request parameter start, the format changed from no format to date-time

    • breaking

      the response's body type changed from object to no type for status

    This list may be incomplete.