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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Charthop

Charthop report API

The report API from Charthop — 9 operation(s) for report.

Documentation Provider Profile APIs.io OpenAPI GitHub

Charthop report API is one of 87 APIs that Charthop 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 12 operations across 9 paths, and defines 23 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

12 operations 9 paths 23 schemas 1 DELETE4 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
ChartHop
Resource Areas
1

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

report 12
GET
/v1/org/{orgId}/report
Return all reports in the organization paginated
findReports 8 params → 200400401404
POST
/v1/org/{orgId}/report
Create a report
createReport 2 params → 201400401403404
POST
/v1/org/{orgId}/report/bulk-delete
Delete a set of reports
bulkDelete 2 params → 200400403404
POST
/v1/org/{orgId}/report/bulk-duplicate
Duplicate a set of reports
bulkDuplicate 2 params → 200400403404
GET
/v1/org/{orgId}/report/count
Return count of reports in an organization
getReportCount 1 param → 200400401404
POST
/v1/org/{orgId}/report/query
Return timeseries data from arbitrary queries
getReportFromQuery 2 params → 200400401404
GET
/v1/org/{orgId}/report/{reportId}
Return a particular report by id
getReport 2 params → 200400404
PATCH
/v1/org/{orgId}/report/{reportId}
Update an existing report
updateReport 4 params → 204400401403404
DELETE
/v1/org/{orgId}/report/{reportId}
Delete a report
deleteReport 2 params → 204400401403404
POST
/v1/org/{orgId}/report/{reportId}/chart/{chartId}/export/csv
Export a particular chart in a report
exportChartCsv 11 params → 200400401404
POST
/v1/org/{orgId}/report/{reportId}/clone
Create an exact copy of an existing report
cloneReport 2 params → 201400401403404
GET
/v1/org/{orgId}/report/{reportId}/query
Query all the charts in a report
getAllReportResults 10 params → 200400401404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Process (29 properties), Report (21 properties), ReportResult (20 properties), GroupByConfig (9 properties). Each schema is shown below with its type and property counts.

LogData
object
4 properties 3 required
ReportResult
object
20 properties 11 required
ReportCount
object
1 property 1 required
UpdateReport
object
7 properties
ReportSeriesQuery
object
4 properties 3 required
ReportFilter
object
2 properties 2 required
AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
ReportDateInterval
object
4 properties 2 required
Attribution
object
6 properties
ReportDataStreamResults
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
ReportGroupByKey
object
5 properties 3 required
ReportQueryResult
object
5 properties 1 required
ReportGroupByDimension
object
1 property 1 required
ReportQuery
object
8 properties 1 required
Report
object
21 properties 6 required
ReportSeriesResult
object
6 properties 5 required
LabelOverride
object
4 properties 1 required
CreateReport
object
7 properties 1 required
GroupByConfig
object
9 properties
ShareAccess
object
4 properties 1 required
LabelColor
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-report-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
AE Profile APIs.io
Charthop action API
AE Profile APIs.io
Charthop ai API
AE Profile APIs.io
Charthop ai-credit-limit API
AE Profile APIs.io
Charthop ai-hint API
AE Profile APIs.io
Charthop ai-prompt API
AE Profile APIs.io
Charthop app API
AE Profile APIs.io
Charthop appConfig API
AE Profile APIs.io
Charthop approval API
AE Profile APIs.io
Charthop approval-delegate API
AE Profile APIs.io
Charthop approval-request API
AE Profile APIs.io
Charthop assessment API
AE Profile APIs.io
#report
← Back to C APIs
API Details
ID
charthop:charthop-report-api
Base URL
https://api.charthop.com
Docs
https://docs.charthop.com/charthop-for-developers
Provider
Charthop
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network