TRANXACT.AI Help

CRM · Reporting

Reports & Analytics

The report catalog for this module, and the models behind it — dimensions and key figures you can rearrange, filter, total and export.

Type REST7 operationsBase path /api/crm/reports

Download specification (OpenAPI 3.1) Screen: Reports & Analytics

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold CRM › Reports & Analytics on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/crm/reports/prospect-funnelProspect funnel

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/reports/prospect-funnel" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/reports/campaign-performanceCampaign performance

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/reports/campaign-performance" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/reports/yieldYield

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/reports/yield" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/reports/survey-resultsSurvey results

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/reports/survey-results" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/reports/engagementEngagement

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/reports/engagement" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/reports/retentionRetention

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/reports/retention" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/reports/pipelinePipeline

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/reports/pipeline" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Reports & Analytics for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.