Analytics

Analytics Documentation

Analytic [GET]

Analytic [GET]

Request

Endpoint

GET /api/v2/account_lists/a4947f51-5a11-4c4a-93d7-157fee3f35aa/analytics
Content-Type: application/vnd.api+json

Body

Parameters

Filters

date_range

Type date

Description period which analytics should be calculated

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "accountlist::analytics",
    "type": "account_list_analytics",
    "attributes": {
      "appointments": {
        "completed": 0
      },
      "contacts": {
        "active": 0,
        "referrals": 0,
        "referrals_on_hand": 0
      },
      "correspondence": {
        "precall": 0,
        "reminders": 0,
        "support_letters": 0,
        "thank_yous": 0,
        "newsletters": 0
      },
      "created_at": "2022-01-12T17:18:33Z",
      "electronic": {
        "appointments": 0,
        "received": 0,
        "sent": 0
      },
      "email": {
        "received": 0,
        "sent": 0
      },
      "end_date": "2022-01-12T17:18:33Z",
      "facebook": {
        "received": 0,
        "sent": 0
      },
      "phone": {
        "appointments": 0,
        "attempted": 0,
        "completed": 0,
        "received": 0,
        "talktoinperson": 0
      },
      "start_date": "2021-12-12T17:18:33Z",
      "text_message": {
        "received": 0,
        "sent": 0
      },
      "updated_at": null,
      "updated_in_db_at": null
    }
  }
}

Fields

Attributes

appointments

Type object

Description Appointment related analytics

contacts

Type object

Description Contact related analytics

correspondence

Type object

Description Correspondence related analytics

created_at

Type date

Description The timestamp of when this resource was created

electronic

Type object

Description Electronic related analytics

email

Type object

Description Email related analytics

end_date

Type string

Description Ending date for analytics period

facebook

Type object

Description Facebook related analytics

phone

Type object

Description Phone related analytics

start_date

Type string

Description Starting date for analytics period

text_message

Type object

Description Text message related analytics

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.