Every endpoint in Reports: 19 operations across 11 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.
Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.
Dashboards
GET/api/dashboards/
List dashboards
curl -X GET https://app.jaicrm.ai/api/dashboards/
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/dashboards/{id}
Read one dashboard
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/dashboards/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/dashboards/
Create a dashboard
curl -X POST https://app.jaicrm.ai/api/dashboards/
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/dashboards/{id}
Change a dashboard
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/dashboards/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/dashboards/{id}
Delete a dashboard
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/dashboards/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Schedules
GET/api/reports/schedules
Run the schedules report
curl -X GET https://app.jaicrm.ai/api/reports/schedules
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/reports/schedules
Run the schedules report
curl -X POST https://app.jaicrm.ai/api/reports/schedules
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/reports/schedules/{id}/send
Run the send report
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/reports/schedules/RECORD_ID/send
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/reports/schedules/{id}
Run the schedules report
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/reports/schedules/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/reports/schedules/{id}
Run the schedules report
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/reports/schedules/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Overview
GET/api/dashboards/overview
List overview
curl -X GET https://app.jaicrm.ai/api/dashboards/overview
-H 'Authorization: Bearer YOUR_API_KEY'CRM
GET/api/dashboards/crm
List crm
curl -X GET https://app.jaicrm.ai/api/dashboards/crm
-H 'Authorization: Bearer YOUR_API_KEY'Sales
GET/api/dashboards/sales
List sales
curl -X GET https://app.jaicrm.ai/api/dashboards/sales
-H 'Authorization: Bearer YOUR_API_KEY'Widget data
POST/api/dashboards/widget-data
Create a widget data
curl -X POST https://app.jaicrm.ai/api/dashboards/widget-data
-H 'Authorization: Bearer YOUR_API_KEY'Data
GET/api/dashboards/{id}/data
List data
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/dashboards/RECORD_ID/data
-H 'Authorization: Bearer YOUR_API_KEY'Sources
GET/api/dashboards/sources
List sources
curl -X GET https://app.jaicrm.ai/api/dashboards/sources
-H 'Authorization: Bearer YOUR_API_KEY'Reports
GET/api/reports/
List reports
curl -X GET https://app.jaicrm.ai/api/reports/
-H 'Authorization: Bearer YOUR_API_KEY'Run
GET/api/reports/{key}/run
Run the run report
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/reports/RECORD_ID/run
-H 'Authorization: Bearer YOUR_API_KEY'Export.{format}
GET/api/reports/{key}/export.{format}
Run the export.:format report
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
format | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/reports/RECORD_ID/export.RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.