Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xentral Report API

Create, manage and export reports and report results based on SQL queries against your data.

Xentral Report API is one of 90 APIs that Xentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Report. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 10 paths. It is described by OpenAPI 3.0.0, at version v0.1.

Requests are made against 2 base URLs: https://{xentralId}.xentral.biz, https://{domain}.

18 operations 10 paths 0 schemas 3 DELETE8 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v0.1
Base URL
https://xentral.xentral.biz
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Xentral Report API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token obtained in POST /tokens endpoint or pregenerated in the system.

Paths & Operations 18

Across 10 paths, the API surfaces 18 operations — 3 DELETE, 8 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Report 18

Create, manage and export reports and report results based on SQL queries against your data.

GET
/api/v1/analytics/report
List reports
analytics.report.list → 200400401403404415
POST
/api/v1/analytics/report
Create report
analytics.report.create body → 200400401403404415
GET
/api/v1/analytics/report/{id}
View report
analytics.report.get 1 param → 200400401403404415
PATCH
/api/v1/analytics/report/{id}
Update report
analytics.report.update 1 param body → 200400401403404415
DELETE
/api/v1/analytics/report/{id}
Delete report
analytics.report.delete 1 param → 204400401403404415
GET
/api/v1/analytics/report/{id}/export
List report exports
analytics.report.export.list 1 param → 200400401403404415
POST
/api/v1/analytics/report/{id}/export
Create report export
analytics.report.export.create 1 param body → 200400401402403404415422
GET
/api/v1/analytics/report/{id}/export/{uuid}
View report export
analytics.report.export.getById 2 params → 200400401403404415
POST
/api/v1/analytics/report/{id}/query
Execute report query
analytics.report.query 2 params body → 200400401402403404415429
GET
/api/v1/analytics/report/{id}/permalink
List report permalink
analytics.report.permalink.get 1 param → 200400401403404415
POST
/api/v1/analytics/report/{id}/permalink
Create report permalink
analytics.report.permalink.create 1 param body → 200400401403404415
DELETE
/api/v1/analytics/report/{id}/permalink
Invalidate permalink for report
analytics.report.permalink.delete 1 param → 204400401403404415
GET
/api/v1/analytics/report/{id}/permalink/{token}
Download report
analytics.report.permalink.download 2 params → 202301400401402403404415
GET
/api/v1/analytics/report/{id}/schedule
List report schedules
analytics.report.schedule.list 1 param → 200400401403404415
POST
/api/v1/analytics/report/{id}/schedule
Create report schedule
analytics.report.schedule.create 1 param body → 200400401403404415
DELETE
/api/v1/analytics/report/{id}/schedule/{uuid}
Delete report schedule
analytics.report.schedule.delete 2 params → 204400401403404415
PATCH
/api/v1/analytics/report/{id}/schedule/{uuid}
Update report schedule
analytics.report.schedule.update 2 params body → 200400401403404415
GET
/api/v1/analytics/schedule
List schedules
analytics.schedule.list → 200400401403404415

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-report-api-openapi.yml Raw ↑

Other APIs Xentral publishes across the network.

Xentral Account API
Xentral Accounting Export API
Xentral AuthPlatform API
Xentral Collection API
Xentral Collective Bill API
Xentral Credit API
Xentral Credit Note API
Xentral Credit Note Tag API
Xentral CreditNote API
Xentral Customer Address API
Xentral Customer API
Xentral Customer - Contact Person API