Reports
Disposition counts over the last N days
GET /v1/reports/dispositions
- Scope
reports:read- Tier
- Tier 1
- Data
- Account data
- Idempotency
- Idempotency-Key: not used
- Limit
- Range: up to 92 days
How many leads ended with each disposition code, over the last days days (1-92, default 30), by the lead's last update. At most 50 codes, most used first.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
days | query | integer | no | (min 1; max 92; default 30) |
X-Correlation-ID | header | string | no | Your own trace value, logged with the request. Metadata only, never identity. (min length 1; max length 128) |
Response
200: The counts.
| Header | Meaning |
|---|---|
X-Request-ID | The DialerBee request id. Quote it to support. Every response carries X-Request-ID: req_<ULID>, or edge_<32 hex> when the edge answered before the request reached the API. |
Cache-Control | Always no-store. |
Examples
Request example
curl
curl -sS -X GET \
"https://app.dialerbee.com/api/v1/reports/dispositions" \
-H "Authorization: Bearer $DIALERBEE_API_KEY"
Python (SDK)
from dialerbee import DialerBee
db = DialerBee() # reads DIALERBEE_API_KEY from the environment
result = db.reports.dispositions()
Response example
200
{
"days": 30,
"total": 120,
"data": [
{
"code": "interested",
"label": "Interested",
"category": "positive",
"count": 42
}
]
}
Error examples
403 insufficient_scope
{
"type": "https://docs.dialerbee.com/errors/insufficient-scope",
"title": "Not permitted",
"status": 403,
"detail": "The API client does not hold the scope this operation requires.",
"instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
"code": "insufficient_scope",
"request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}
401 invalid_api_key
{
"type": "https://docs.dialerbee.com/errors/invalid-api-key",
"title": "Invalid API key",
"status": 401,
"detail": "The Authorization header is missing, is not Bearer dbk_live_..., or the key is not recognised, has expired or was revoked (one answer for every key problem, so a key's state is never revealed).",
"instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
"code": "invalid_api_key",
"request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}
Errors
| Status | Code | Title |
|---|---|---|
| 401 | invalid_api_key | Invalid API key |
| 403 | api_access_disabled | API access disabled |
| 403 | ip_not_allowed | IP address not allowed |
| 403 | insufficient_scope | Not permitted |
| 400 | credential_in_url | Credential in URL |
| 400, 422 | validation_failed | Invalid request |
| 429 | rate_limit_exceeded | Too many requests |
| 503 | temporarily_unavailable | Temporarily unavailable |
| 503 | upstream_unavailable | Temporarily unavailable |
| 502 | upstream_invalid_response | Upstream error |
| 500 | internal_error | Internal error |
Objects
DispositionReport
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | yes | |
total | integer | yes | |
data | array of DispositionCount | yes | (max items 50) |
DispositionCount
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | |
label | string or null | yes | |
category | string or null | yes | |
count | integer | yes |