Activity Results

Activity Results Documentation

Activity Result [LIST]

Activity Result [LIST]

Request

Endpoint

GET /api/v2/reports/activity_results
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type string

Description The account list to run the report on.

Required No

end_date

Type string

Description The date in which you would like the report to end on. This will be shifted to the end of the final period. Default: today

Required No

start_date

Type string

Description The date in which you would like the report to start on. This will be shifted to the start of the final period. Default: today

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "2022-01-09",
      "type": "reports_activity_results_periods",
      "attributes": {
        "calls_with_appointment_next": 0,
        "completed_call": 0,
        "completed_pre_call_letter": 0,
        "completed_reminder_letter": 0,
        "completed_support_letter": 0,
        "completed_thank": 0,
        "created_at": "2022-01-12T17:19:01Z",
        "dials": 0,
        "electronic_message_sent": 0,
        "electronic_message_with_appointment_next": 0,
        "end_date": "2022-01-15T23:59:59Z",
        "start_date": "2022-01-09T00:00:00Z",
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2022-01-02",
      "type": "reports_activity_results_periods",
      "attributes": {
        "calls_with_appointment_next": 0,
        "completed_call": 0,
        "completed_pre_call_letter": 0,
        "completed_reminder_letter": 0,
        "completed_support_letter": 0,
        "completed_thank": 0,
        "created_at": "2022-01-12T17:19:01Z",
        "dials": 0,
        "electronic_message_sent": 0,
        "electronic_message_with_appointment_next": 0,
        "end_date": "2022-01-08T23:59:59Z",
        "start_date": "2022-01-02T00:00:00Z",
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-12-26",
      "type": "reports_activity_results_periods",
      "attributes": {
        "calls_with_appointment_next": 0,
        "completed_call": 0,
        "completed_pre_call_letter": 0,
        "completed_reminder_letter": 0,
        "completed_support_letter": 0,
        "completed_thank": 0,
        "created_at": "2022-01-12T17:19:01Z",
        "dials": 0,
        "electronic_message_sent": 0,
        "electronic_message_with_appointment_next": 0,
        "end_date": "2022-01-01T23:59:59Z",
        "start_date": "2021-12-26T00:00:00Z",
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-12-19",
      "type": "reports_activity_results_periods",
      "attributes": {
        "calls_with_appointment_next": 0,
        "completed_call": 0,
        "completed_pre_call_letter": 0,
        "completed_reminder_letter": 0,
        "completed_support_letter": 0,
        "completed_thank": 0,
        "created_at": "2022-01-12T17:19:01Z",
        "dials": 0,
        "electronic_message_sent": 0,
        "electronic_message_with_appointment_next": 0,
        "end_date": "2021-12-25T23:59:59Z",
        "start_date": "2021-12-19T00:00:00Z",
        "updated_at": null,
        "updated_in_db_at": null
      }
    }
  ],
  "meta": {
    "sort": null,
    "filter": {
    },
    "averages": {
      "average_completed_pre_call_letter": 0,
      "average_completed_reminder_letter": 0,
      "average_completed_support_letter": 0,
      "average_completed_thank": 0,
      "average_calls_with_appointment_next": 0,
      "average_dials": 0,
      "average_completed_call": 0,
      "average_electronic_message_sent": 0,
      "average_electronic_message_with_appointment_next": 0
    }
  }
}