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 Dashboards API

The Dashboards API from CaptivateIQ — 2 operation(s) for dashboards.

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

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

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

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

4 operations 2 paths 6 schemas 1 DELETE2 GET1 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 Dashboards 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 4

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

Dashboards 4
GET
/ciq/v1/dashboards/published-dashboards/
List Published Dashboards
dashboards_published_dashboards_list → 200
POST
/ciq/v1/dashboards/{dashboard_id}/embedded_share
Share Dashboard
dashboards_embedded_share_create 1 param body → 201
DELETE
/ciq/v1/dashboards/{dashboard_id}/embedded_share
Unshare Dashboard
dashboards_embedded_share_destroy 1 param body → 200
GET
/ciq/v1/dashboards/{dashboard_id}/embedded_share
List Users With Access
dashboards_embedded_share_list 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Dashboard (11 properties), EmbeddedUsersSharedResource (5 properties), PaginatedDashboardList (3 properties), PaginatedEmbeddedUsersSharedResourceList (3 properties). Each schema is shown below with its type and property counts.

EmbeddedUsersUUID
object
1 property 1 required
EmbeddedUsersSharedResource
object
5 properties 2 required
PaginatedEmbeddedUsersSharedResourceList
object
3 properties
PaginatedDashboardList
object
3 properties
SharedResourcesDelete
object
1 property 1 required
Dashboard
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-dashboards-api-openapi.yml Raw ↑

Other APIs CaptivateIQ publishes across the network.

CaptivateIQ Attribute Worksheets API
CaptivateIQ Audit Logs API
CaptivateIQ Commission Plans 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
CaptivateIQ Report Models API