APIDocumentation

Authentication

Every request carries your API key in the Authorization header. There is no separate login call.

Example: check your balance

curl https://www.datascope.digital/api/v1/credits \
  -H "Authorization: Bearer YOUR_API_KEY"

Request Headers

API Endpoints

Every endpoint available today, relative to https://www.datascope.digital/api/v1.

Code Examples

Common calls, ready to paste into a terminal.

Create an Analysis

curl -X POST https://www.datascope.digital/api/v1/analysis \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Q3 sales",
    "analysisType": "DESCRIPTIVE",
    "dataUrl": "https://example.com/exports/q3-sales.csv",
    "fileName": "q3-sales.csv"
  }'

analysisType is one of DESCRIPTIVE, DIAGNOSTIC, PREDICTIVE, PRESCRIPTIVE or CUSTOM (default DESCRIPTIVE). An analysis needs at least 10 credits on your balance.

Get an Analysis

curl https://www.datascope.digital/api/v1/analysis/ANALYSIS_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

List Your Analyses

curl https://www.datascope.digital/api/v1/analysis \
  -H "Authorization: Bearer YOUR_API_KEY"

Rate Limits

Every account gets the same API access. Rate limits are set per key, not by plan - there are no plans or tiers.