Analytics API

With analytics api V4 you can get insights and metrics about the reports under specified criteria.

All api endpoints require 3 parameters:

Reports images API

GET /api/v4/analytics/reports_images?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z

[
  {
    "report_image_id": 3,
    "account_id": 1,
    "report_id": 2,
    "created_at": "2016-11-07T00:00:00.000Z",
    "styles": {
      "thumb": "https://s3.to/thumb-image.url",
      "medium": "https://s3.to/medium-image.url"
    }
  },
  ...
]

Reports over time API

GET /api/v4/analytics/reports_over_time?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z

[
  {
    "account_id": 1,
    "datetime_range_start": "2016-11-07T00:00:00.000Z",
    "report_count": 2,
    "datetime_range_width": "week"
  },
  ...
]

Reports per field selection API

field Id is required you, can use Forms API to fetch field_id. Calls to this api are supported only for field which field_type is equals to Category, DropDown and Radio.

GET /api/v4/analytics/reports_per_field_selection?field_id=2&channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z

[
  {
    "field_id": 2,
    "account_id": 1,
    "name": "Resolved",
    "value": "f_1_2_2_2_1",
    "report_count": 1
  },
  ...
]

Reports per state API

GET /api/v4/analytics/reports_per_state?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z

[
  {
    id: 1,
    name: 'state name',
    account_id: 1,
    report_count: 23
  },
  ...
]

Reports per user API

GET /api/v4/analytics/reports_per_user?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z

[
  {
    "user_id": 3,
    "account_id": 1,
    "report_count": 17
  },
  ...
]

Reports per day hour API

GET /api/v4/analytics/reports_per_day_hour?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z

[
  {
    "account_id": 1,
    "hour": 1,
    "report_count": 6
  },
  ...
]

Reports per week day API

GET /api/v4/analytics/reports_per_week_day?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z

[
  {
    "account_id": 1,
    "dow": 1,
    "report_count": 6
  },
  ...
]

Reports Read API

GET /api/v4/analytics/reports_read?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z&fields=total_reads,unique_reads,report_readers,reports_seen

{
  total_reads: 10,
  reports_seen: 8,
  report_readers: 3,
  unique_reads: 5,
}

Available Fields

Only total_reads is returned if none is selected. Otherwise only what has been asked for will be returned.

User Awareness API

GET /api/v4/analytics/user_awareness?channel_id=1&start_date=2016-01-01T00:00:00Z&end_date=2016-11-11T00:00:00Z&fields=total_alerts,alert_source_reports,unique_alerts,alerts_opened

[
  {
    "total_alerts": 5,
    "alert_source_reports": 1,
    "unique_alerts": 1,
    "alerts_opened": 1,
    "user_id": 3,
    "first_name": "John",
    "last_name": "Doe"
  },
  ...
]

Available Optional Fields

Only total_alerts is returned if none is selected. Otherwise only what has been asked for will be returned.