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

WorkSpan View API

The View API from WorkSpan — 4 operation(s) for view.

WorkSpan View API is one of 26 APIs that WorkSpan publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include View. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api-sandbox.workspan.com/oauth.

4 operations 4 paths 0 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api-sandbox.workspan.com/oauth
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

WorkSpan View API declares 2 security schemes for authenticating requests. An API key is passed in the header as Ocp-Apim-Subscription-Key (apiKeyHeader). An API key is passed in the query as subscription-key (apiKeyQuery). By default, every request must be authenticated, though some operations may also be called without credentials.

Paths & Operations 4

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

View 4
POST
/view/{viewId}/data
Get report view data
getReportViewData 2 params body → 200400401404500
GET
/view/{viewId}
Get report view metadata
getReportViewMetadata 2 params → 200400404500
GET
/view/{viewId}/status
Get report view status
checkReportViewStatus 2 params → 200400401404500
POST
/view/{reportId}/prepare_export
Prepare report view
prepareExport 2 params body → 200400401404500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workspan-view-api-openapi.yml Raw ↑

Other APIs WorkSpan publishes across the network.

WorkSpan Actions API
WorkSpan Audit API
WorkSpan Authorize API
WorkSpan Bulkload API
WorkSpan Bulkload Opportunity API
WorkSpan Chart Data API
WorkSpan Chart Metadata API
WorkSpan Check Attribute API
WorkSpan Cosell API
WorkSpan Crm Inbound API
WorkSpan Crm Inbound V2 API
WorkSpan Data API