Dashboard API

Dashboard Summary

Retrieve all dashboard statistics in a single call.

Endpoint

POST /v2/dashboard

Authentication

Header	Required	Description
`X-API-Key`	Yes	Your API key
`Content-Type`	Yes	`application/json`

Request Body

Field	Type	Required	Description
`filter`	string	Yes	Time period filter (see Filter Values)
`channels`	array	No	Channel IDs to filter by. Empty array for all
`email`	string	No	Filter by agent email. Empty for all agents
`groupsID`	array	No	Group IDs to filter by. Empty array for all
`timezoneOffset`	string	No	Timezone offset (e.g. `+03:00`). Default: `+03:00`
`sla`	object	No	SLA thresholds in seconds
`sla.service`	number	No	Service time threshold (seconds)
`sla.response`	number	No	Response time threshold (seconds)
`sla.waiting`	number	No	Waiting time threshold (seconds)

Example

curl -X POST "https://api.experiaapp.com/v2/dashboard" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": "daily",
    "channels": [],
    "groupsID": [],
    "timezoneOffset": "+03:00",
    "sla": { "service": 60, "response": 30, "waiting": 120 }
  }'

Response

{
  "totalSessions": 458,
  "averageWaitingTime": "00 00:00:20",
  "averageResponseTime": "00 00:17:25",
  "averageServiceTime": "00 15:49:32",
  "minServiceTime": "00 00:00:05",
  "maxServiceTime": "00 16:29:47",
  "CSAT": 62.5,
  "FCR": 0,
  "NPS": 0,
  "agentTotalTimeOnline": "00 00:00:00",
  "totalMsg": 1250,
  "totalTags": 45,
  "totalTransferred": 12,
  "peakTime": "10:00",
  "weakTime": "03:00",
  "totalClosedSessions": 420,
  "totalTemplateUsage": 85,
  "totalPredefinedMessages": 320,
  "totalClient": 380,
  "totalTagsPercent": 10.7,
  "sla": {
    "response": 85.5,
    "waiting": 92.3,
    "service": 78.2
  },
  "status": "SUCCESS"
}

Card Content (Detail)

Retrieve detailed data for a specific dashboard card.

Endpoint

POST /v2/dashboard/{cardName}

Authentication

Header	Required	Description
`X-API-Key`	Yes	Your API key
`Content-Type`	Yes	`application/json`

Path Parameter

Parameter	Type	Required	Description
`cardName`	string	Yes	The card identifier (see available cards below)

Body (JSON)

Field	Type	Required	Description
`filter`	string	No	Time period filter. Defaults to `daily`
`for`	string	No	Data category: `session` (default) or `hospitality`
`email`	string	No	Filter by specific agent email
`channels`	array	No	Filter by channel IDs. Empty array for all
`groupsID`	array	No	Filter by group IDs. Empty array for all
`timezoneOffset`	string	No	Timezone offset (e.g. `+03:00`). Default: `+03:00`
`sla`	object	No	SLA thresholds in seconds
`sla.service`	number	No	Service time threshold (seconds)
`sla.response`	number	No	Response time threshold (seconds)
`sla.waiting`	number	No	Waiting time threshold (seconds)
`shiftIDs`	array	No	Filter by shift IDs

Filter Values

Value	Description
`daily` / `TODAY`	Current day
`weekly` / `WEEK`	Current week
`monthly` / `MONTH`	Current month
`YEAR`	Current year
`YYYY-MM-DD to YYYY-MM-DD`	Custom date range (e.g. `2026-01-01 to 2026-01-31`)

Available Cards

Session Cards

Card Name	Description
`CARDTOTALSESSIONS`	Total sessions count
`CARDTOTALCLOSEDSESSIONS`	Total closed sessions
`CARDTOTALTRANSFERRED`	Total transferred sessions
`CARDNEWCLIENTS`	New clients count

Time & Performance Cards

Card Name	Description
`CARDWAITINGTIME`	Waiting time metrics
`CARDSERVICETIME`	Service time metrics
`CARDMINSERVICETIME`	Minimum service time
`CARDMAXSERVICETIME`	Maximum service time
`CARDAVGRESPONSETIME`	Average response time
`CARDPEAKTIME`	Peak activity time
`CARDWEAKTIME`	Lowest activity time

Quality & Satisfaction Cards

Card Name	Description
`CARDCSAT`	Customer satisfaction score
`CARDFCR`	First contact resolution
`CARDNPS`	Net promoter score

Activity Cards

Card Name	Description
`CARDTOTALMESSAGES`	Total messages count
`CARDTOTALTIME`	Total online time
`CARDTAGS`	Tags breakdown
`CARDTAGSPERCENTAGE`	Tags percentage report
`CARDQUEUEREPORT`	Queue summary report
`CARDTEMPLATEUSAGE`	Template usage stats
`CARDPREDEFINEDMESSAGES`	Predefined messages usage

Example

Request

curl -X POST "https://api.experiaapp.com/v2/dashboard/CARDTOTALCLOSEDSESSIONS" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channels": [],
    "email": "",
    "filter": "daily",
    "timezoneOffset": "+03:00",
    "sla": { "service": 0, "response": 0, "waiting": 0 },
    "for": ""
  }'

Response

{
  "status": "SUCCESS",
  "cardName": "CARDTOTALCLOSEDSESSIONS",
  "cardContent": [
    {
      "session_key": "abc123xyz",
      "client_id": 10001,
      "username": "9665XXXXXXXX",
      "created_date": "2026-01-15T10:30:00.000000Z",
      "taken_date": "2026-01-15T10:31:15.000000Z",
      "ended_date": "2026-01-15T10:45:30.000000Z",
      "status": "CLOSED",
      "type": "whatsapp",
      "agent_email": "agent@example.com"
    }
  ]
}

Rate Limiting

200 requests per hour per API key
HTTP 429 returned when limit is exceeded

Documentation

Dashboard API

Dashboard Summary

Endpoint

Authentication

Request Body

Example

Response

Card Content (Detail)

Endpoint

Authentication

Path Parameter

Body (JSON)

Filter Values

Available Cards

Session Cards

Time & Performance Cards

Quality & Satisfaction Cards

Activity Cards

Example

Request

Response

Rate Limiting