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

Castor Reports API

Reports / repeating data and their instances.

Castor Reports API is one of 11 APIs that Castor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 2 base URLs: https://data.castoredc.com/api, https://us.castoredc.com/api.

4 operations 4 paths 3 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://data.castoredc.com/api
Authentication
OAuth 2.0
Contact
Resource Areas
1

Authentication & Security 1

Castor Reports API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 4

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

Reports 4

Reports / repeating data and their instances.

GET
/study/{study_id}/report
List reports (repeating data)
listReports 1 param → 200
GET
/study/{study_id}/report/{report_id}
Retrieve a report
getReport 2 params → 200
GET
/study/{study_id}/participant/{participant_id}/data-points/repeating-data-instance
List a participant's repeating-data instances
listRepeatingDataInstances 2 params → 200
POST
/study/{study_id}/participant/{participant_id}/data-points/repeating-data-instance/{repeating_data_instance_id}
Update a repeating-data instance's data points
updateRepeatingDataInstance 3 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DataPoint (4 properties), DataPointCollection (3 properties), DataPointWriteRequest (2 properties). Each schema is shown below with its type and property counts.

DataPointWriteRequest
object
2 properties 1 required
DataPointCollection
object
3 properties
DataPoint
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

castoredc-reports-api-openapi.yml Raw ↑

Other APIs Castor publishes across the network.

Castor Audit Trail API
Castor Data Export API
Castor Fields API
Castor Institutes API
Castor Metadata API
Castor Participants API
Castor Studies API
Castor Study Data Points API
Castor Surveys API
Castor Users API