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

CaptivateIQ Report Models API

The Report Models API from CaptivateIQ — 5 operation(s) for report models.

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

Tagged areas include Report Models. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 5 operations across 5 paths, and defines 17 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.captivateiq.com.

5 operations 5 paths 17 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.captivateiq.com/ciq/v1/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

CaptivateIQ Report Models API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 5

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

Report Models 5
GET
/ciq/v1/report-models/
List Report Models
report_models_list 6 params → 200
POST
/ciq/v1/report-models/export-worksheet/
Export Report Model Worksheet
report_models_export_worksheet_create body → 200
GET
/ciq/v1/report-models/exports
List Report Models Exports
report_models_exports_list 6 params → 200
GET
/ciq/v1/report-models/{id}/
Retrieve Report Model
report_models_retrieve 1 param → 200
POST
/ciq/v1/report-models/{report_model_uuid}/records/export/
Export Report Model Worksheet Records
report_models_records_export_create 1 param body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Job (8 properties), DetailReportModelOpenAPI (7 properties), ListReportModelOpenAPI (7 properties), ListReportOutputOpenAPI (7 properties). Each schema is shown below with its type and property counts.

ListReportOutputWorksheetSnapshot
object
3 properties 2 required
ReportOutputExportRequest
object
4 properties 3 required
Job
object
8 properties 1 required
ReportModelColumnOpenAPI
object
4 properties 3 required
Sort
object
1 property 1 required
ListReportModelOpenAPI
object
7 properties 6 required
PaginatedListReportOutputOpenAPIList
object
5 properties
ColumnFilter
object
3 properties 3 required
DetailReportModelOpenAPI
object
7 properties 6 required
PaginatedListReportModelOpenAPIList
object
5 properties
ListReportModelCalculationModelWorksheet
object
5 properties 4 required
PeriodDate
object
3 properties 1 required
JobMetadata
object
5 properties
ReportModelRecordsExportRequest
object
5 properties 1 required
OpEnum
string
DetailReportModelWorksheetOpenAPI
object
6 properties 5 required
ListReportOutputOpenAPI
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-report-models-api-openapi.yml Raw ↑

Other APIs CaptivateIQ publishes across the network.

CaptivateIQ Attribute Worksheets API
CaptivateIQ Audit Logs API
CaptivateIQ Commission Plans API
CaptivateIQ Dashboards API
CaptivateIQ Data Workbooks API
CaptivateIQ Data Worksheets API
CaptivateIQ Employee Assumptions API
CaptivateIQ Employees API
CaptivateIQ Hierarchies API
CaptivateIQ Jobs API
CaptivateIQ Metadata API
CaptivateIQ Payouts API