Analytics

Analytics Documentation

Analytic [GET]

Analytic [GET]

Request

Endpoint

GET /api/v2/tasks/analytics?filter[account_list_id]=32aae5ed-cae5-4b47-8470-a33022ffe4b8
Content-Type: application/vnd.api+json

Body

filter: {"account_list_id"=>"32aae5ed-cae5-4b47-8470-a33022ffe4b8"}

Parameters

Filters

account_list_id

Type string

Description The account list to run the analytics report on

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "task::analytics",
    "type": "task_analytics",
    "attributes": {
      "created_at": "2022-01-12T17:18:16Z",
      "last_electronic_newsletter_completed_at": "2022-01-10T17:18:16Z",
      "last_physical_newsletter_completed_at": null,
      "tasks_overdue_or_due_today_counts": [
        {
          "label": "Call",
          "count": 0
        },
        {
          "label": "Appointment",
          "count": 0
        },
        {
          "label": "Email",
          "count": 0
        },
        {
          "label": "Text Message",
          "count": 0
        },
        {
          "label": "Facebook Message",
          "count": 0
        },
        {
          "label": "Letter",
          "count": 0
        },
        {
          "label": "Newsletter - Physical",
          "count": 0
        },
        {
          "label": "Newsletter - Email",
          "count": 0
        },
        {
          "label": "Pre Call Letter",
          "count": 0
        },
        {
          "label": "Reminder Letter",
          "count": 0
        },
        {
          "label": "Support Letter",
          "count": 0
        },
        {
          "label": "Thank",
          "count": 0
        },
        {
          "label": "To Do",
          "count": 0
        },
        {
          "label": "Talk to In Person",
          "count": 0
        },
        {
          "label": "Prayer Request",
          "count": 0
        },
        {
          "label": null,
          "count": 0
        }
      ],
      "total_tasks_due_count": 0,
      "updated_at": null,
      "updated_in_db_at": null
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

last_electronic_newsletter_completed_at

Type date

Description Last Electronic Newsletter Completed At

last_physical_newsletter_completed_at

Type date

Description Last Physical Newsletter Completed At

tasks_overdue_or_due_today_counts

Type ["Object"]

Description Tasks Overdue or Due Today Counts

total_tasks_due_count

Type number

Description Total Tasks Due Count

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.