API reference
Reports
Numbers for dashboards and exports.
GET/reports/export
Get export (reports)
Needs the permission reports:export.
| Parameter | In | Type | Notes |
|---|---|---|---|
from | query | string | |
to | query | string | |
includeTest | query | one of true, false |
curl -X GET https://crm.anibrosdesign.com/api/v1/reports/export \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
GET/reports/flow
Get flow (reports)
Needs the permission reports:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
from | query | string | |
to | query | string | |
includeTest | query | one of true, false |
curl -X GET https://crm.anibrosdesign.com/api/v1/reports/flow \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
GET/reports/leads
Get leads (reports)
Needs the permission reports:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
limit | query | integer | at least 1. up to 200. default 50 |
cursor | query | string | up to 512 characters |
from | query | string | |
to | query | string | |
includeTest | query | one of true, false | |
metric required | query | one of leads, qualified, visits, booked, won | |
owner | query | string (uuid) or one of unassigned |
curl -X GET https://crm.anibrosdesign.com/api/v1/reports/leads \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
GET/reports/overview
Get overview (reports)
Needs the permission reports:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
from | query | string | |
to | query | string | |
includeTest | query | one of true, false |
curl -X GET https://crm.anibrosdesign.com/api/v1/reports/overview \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
Something missing or unclear? Tell us.