Developer Resources

This page contains information about available resources to help you integrate CxReports into your environment.

API Clients

To interact with CxReports programmatically, you can use our API clients available on NPM and NuGet. These clients allow you to easily integrate CxReports functionalities into your applications.

Code

Node.jsC#Python

npm install @cx-reports/api-client

dotnet add package CxReports.ApiClient

pip install cxreports-api-client

• @cx-reports/api-client npm package for TypeScript/JavaScript projects
• CxReports.ApiClient NuGet package for .NET projects
• cxreports-api-client PyPi package for Python projects

Swagger / OpenAPI

Every CxReports instance ships with an interactive Swagger UI that documents the full public API. It is the most up-to-date reference for your installed version, and it lets you authorize with a Personal Access Token, inspect request and response schemas, and try calls live against your own data.

• Swagger UI: /swagger/index.html on your instance. Enable Swagger in your configuration if it is not already on.
• OpenAPI document: /swagger/v1/swagger.json — import into Postman, Insomnia, or any OpenAPI client generator to scaffold a custom client.
• Authorize: click the Authorize button in Swagger UI and paste a Personal Access Token (issued from your user avatar → Personal Access Tokens). All subsequent "Try it out" calls go out as the authenticated user.

The OpenAPI document is also the source of truth used by the official API clients listed above, so the schemas you see in Swagger match what those clients expect.

Demo Applications

To help you get started quickly, we provide demo applications that showcase how to integrate and use CxReports in different environments. These demos can serve as a reference or a starting point for your own projects.

• Next.js Demo Application

Additional Resources

For more detailed information, code examples, and further documentation, please visit our GitHub page.