Skip to main content
GET
/
v2
/
analytics
/
tasks
/
dashboard
Get dashboard data (progress bar, action groups, charts)
curl --request GET \
  --url https://api.example.com/v2/analytics/tasks/dashboard \
  --header 'Authorization: Bearer <token>'
{
  "weekly_progress": {
    "completed": 1,
    "total": 1,
    "open_count": 1,
    "percentage": 0
  },
  "summary": {
    "payment_promises_due_today": 1,
    "invoices_due_today_amount": 1,
    "invoices_due_today_customers": 1
  },
  "action_groups": {
    "respond_to": [
      {
        "count": 1,
        "amount": 1,
        "customer_count": 1,
        "action_type": "disputes"
      }
    ],
    "collect": [
      {
        "count": 1,
        "amount": 1,
        "customer_count": 1,
        "action_type": "disputes"
      }
    ]
  },
  "charts": {
    "by_age": [
      {
        "label": "<string>",
        "count": 1,
        "id": "<string>"
      }
    ],
    "by_type": [
      {
        "label": "<string>",
        "count": 1,
        "id": "<string>"
      }
    ],
    "by_customer": [
      {
        "label": "<string>",
        "count": 1,
        "id": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

assignee_ids
string[] | null

Filter by specific assignee IDs.

Response

Successful Response

weekly_progress
object
required
summary
object
required
action_groups
object
required
charts
object
required