Be first to try Soda's new AI-powered metrics observability, and collaborative data contracts.
Request a Demo!
LogoLogo
Soda v3
Soda v3
  • Soda v3 documentation
  • Get started
    • Get started roadmap
    • Choose a flavor of Soda
    • Install Soda Library
    • Set up a Soda-hosted agent
    • Deploy a Soda Agent
    • Deploy a self-hosted Soda Agent from Soda's private container registry
    • Soda Agent extras
    • Invoke Soda Library
    • Upgrade, redeploy, or uninstall Soda
  • Use case guides
    • Test data quality in an Airflow data pipeline
    • Test data quality in an Azure Data Factory pipeline
    • Test data quality in a Dagster pipeline
    • Test data quality in a Databricks pipeline
    • Test data quality before migration
    • Test data quality during CI/CD development
    • Self-serve Soda
    • Automate anomaly detection
    • Build a Sigma dashboard
    • Build a Grafana dashboard
    • Add Soda to a Databricks notebook
    • Integrate an External Secrets Manager with a Soda Agent
    • Generate API keys
    • Manage sensitive data
    • Reroute failed row samples
    • Double-onboard a data source
  • Write SodaCL checks
    • SodaCL tutorial
    • Write checks with Ask AI
    • Adopt check suggestions
    • Add automated monitoring checks
    • Profile data with Soda
    • Sample data with Soda
    • Compare data using SodaCL
    • Custom check examples
  • Run a scan and view results
    • Manage failed row samples
    • Manage scheduled scans
    • Configure orchestrated scans
    • Soda Library Python API reference
  • Organize results, set alerts, investigate issues
    • Activate anomaly dashboards
    • Add check attributes
    • Set notification rules
    • Organize datasets
    • Create and track incidents
    • Manage global roles, user groups, and settings
    • Manage dataset roles
  • Integrate Soda
    • Integrate Soda with Alation
    • Integrate Soda with Atlan
    • Integrate Soda with dbt
    • Integrate Soda with a GitHub Workflow
    • Integrate Soda with Jira
    • Integrate Soda with Microsoft Teams
    • Integrate Soda with Purview
    • Integrate Soda with ServiceNow
    • Integrate Soda with Slack
    • Integrate Soda with SSO
    • Integrate Soda with webhooks
  • SodaCL reference
    • SodaCL metrics and checks
    • SodaCL optional check configurations
    • Anomaly detection checks (deprecated)
    • Anomaly score checks (deprecated)
    • Check template
    • Cross checks
    • Distribution checks
    • Failed rows checks
    • Filters and variables
    • For each
    • Freshness checks
    • Group by
    • Group evolution checks
    • Missing metrics
    • Numeric metrics
    • Reconciliation checks
    • Reference checks
    • Schema checks
    • User-defined checks
    • Validity metrics
    • Troubleshoot SodaCL
  • Data source reference
    • Connect Soda to Amazon Athena
    • Connect Soda to GCP BigQuery
    • Connect Soda to ClickHouse
    • Connect Soda to Dask and Pandas
    • Connect Soda to Databricks
    • Connect Soda to Denodo
    • Connect Soda to Dremio
    • Connect Soda to DuckDB
    • Connect Soda to Google CloudSQL
    • Connect Soda to IBM DB2
    • Connect Soda to a local file using Dask
    • Connect Soda to MotherDuck
    • Connect Soda to MS SQL Server
    • Connect Soda to Microsoft Fabric
    • Connect Soda to MySQL
    • Connect Soda to OracleDB
    • Connect Soda to PostgreSQL
    • Connect Soda to Presto
    • Connect Soda to Amazon Redshift
    • Connect Soda to Snowflake
    • Connect Soda to Apache Spark
    • Connect Soda to Azure Synapse
    • Connect Soda to Trino
    • Connect Soda to Vertica
    • Troubleshoot data source connections
  • Soda Cloud API v1
    • Authentication
    • Examples
    • Checks
    • Datasets
    • Incidents
    • Scans
    • Users
    • Utility
    • Models
    • GET checks into CSV files
  • Soda Cloud Reporting API v1
    • Authentication
    • Examples
    • Status
    • Authentication
    • Auditing
    • Coverage
    • Quality
    • Platform Impact
    • Models
    • Reporting API migration guide
  • Set up data contracts
    • Write a data contract
    • Verify a data contract
    • Data contract check reference
  • Learning resources
    • Glossary
    • Soda overview
    • How Soda works
    • Soda Agent basic concepts
    • Soda architecture
    • Active checks and datasets
    • Data security and privacy
    • Soda Library usage statistics
    • Support
    • Soda community code of conduct
    • Soda SQL and Soda Spark are now Soda Core
  • Soda Core
  • Release notes
    • Soda product release states
    • Release notes for Soda products
    • Release notes for Soda Library
    • Release notes for Soda Agent
    • Release notes for Soda Cloud
    • Release notes for Soda Cloud API
    • Release notes for Soda Cloud Reporting API
    • Release notes for Soda Core
Powered by GitBook
On this page
Export as PDF
  1. Soda Cloud Reporting API v1

Coverage

PreviousAuditingNextQuality

Was this helpful?

CtrlK
  • POSTChecks [Paginated]
  • POSTDatasets [Paginated]
  • POSTDataset coverage

Was this helpful?

Checks [Paginated]

post

This endpoint provides a real-time list of all the check that exist in your organization's account, as well as the datasets upon which each check depends.

Usage

Use this endpoint to enrich results from the /datasets or /check_results endpoints.

Returns

An object of type CheckResult containing an array of CheckData for each check.

Find details about the response objects in the Schemas section or by unfurling the response details.

Authorizations
Body
all ofOptionalDefault: {"page":1,"size":400}
Responses
200

Successful Response

application/json
202

Successful request but no data was returned

application/json
422

Validation Error

application/json
post
POST /v1//coverage/checks HTTP/1.1
Host: reporting.cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "page": 1,
  "size": 400,
  "dataset_ids": [
    "text"
  ],
  "check_ids": [
    "text"
  ]
}
{
  "total": 1,
  "page": 1,
  "size": 1,
  "data": [
    {
      "check_id": "text",
      "organization_id": "text",
      "check_name": "text",
      "check_type": "text",
      "created_at": "2025-08-25T12:16:55.250Z",
      "is_archived": "text",
      "dataset_id": "text",
      "owner_id": "text",
      "owner_first_name": "text",
      "owner_last_name": "text",
      "owner_email": "text",
      "owner_job_title": "text",
      "owner_phone_number": "text",
      "owner_user_type": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "check_group_aggregate_id": "text",
      "check_group_id": "text",
      "is_group_aggregate_check": true,
      "source": "text"
    }
  ]
}

Datasets [Paginated]

post

This endpoint provides information about all the datasets that your team has connected to your organization's Soda Cloud account.

Usage

Use this endpoint to review the number of datasets Soda Cloud accesses, including each dataset's most recent scan time and test failure counts.

Use the data from this endpoint to enrich other endpoints' data such as /dataset_health and /dataset_coverage

Returns

An object of type DatasetsResult containing an array of DatasetsData

Find details about the response objects in the Schemas section or by unfurling the response details.

Authorizations
Body
all ofOptionalDefault: {"page":1,"size":400}
Responses
200

Successful Response

application/json
202

Successful request but no data was returned

application/json
422

Validation Error

application/json
post
POST /v1//coverage/datasets HTTP/1.1
Host: reporting.cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "page": 1,
  "size": 400,
  "dataset_ids": [
    "text"
  ]
}
{
  "total": 1,
  "page": 1,
  "size": 1,
  "data": [
    {
      "dataset_id": "text",
      "organization_id": "text",
      "dataset_name": "text",
      "dataset_label": "text",
      "tags": [
        "text"
      ],
      "owner_id": "text",
      "owner_first_name": "text",
      "owner_last_name": "text",
      "owner_email": "text",
      "owner_job_title": "text",
      "owner_phone_number": "text",
      "owner_user_type": "text",
      "owner_last_login_at": "2025-08-25T12:16:55.250Z",
      "number_of_rows": 1,
      "number_of_failed_checks": 1,
      "last_scan_time": "2025-08-25T12:16:55.250Z",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "datasource_id": "text",
      "datasource_name": "text",
      "datasource_label": "text",
      "datasource_source_owner": "text",
      "datasource_owner_id": "text",
      "datasource_has_core_agent_enabled": true
    }
  ]
}

Dataset coverage

post

This endpoint provides a daily measure of the test coverage of your datasets. It derives a relative_coverage_score which compares the number of checks that apply to a single dataset to other datasets connected to your organization's Soda Cloud account. (Refer to the DatasetCoverageData schema for more information.)

Usage

Use this endpoint to review the relative test coverage of your datasets, and to see a high-level view of the more granular information that the /tests_and_results endpoint provides.

This endpoint is best used in conjunction with the /datasets endpoint as the latter augments the level of information about each dataset.

Returns

An object of type DatasetCoverageResult containing an array of DatasetCoverageData

Find details about the response objects in the Schemas section or by unfurling the response details.

Authorizations
Body
all ofOptionalDefault: {}
Responses
200

Successful Response

application/json
202

Successful request but no data was returned

application/json
422

Validation Error

application/json
post
POST /v1//coverage/dataset_coverage HTTP/1.1
Host: reporting.cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "dataset_ids": [
    "text"
  ]
}
{
  "data": {
    "descriptives": {
      "median_number_of_checks": 0,
      "max_number_of_checks": 0,
      "min_number_of_checks": 0,
      "standard_deviation_number_of_checks": 0,
      "mean_number_of_checks": 0
    },
    "dataset_info": [
      {
        "dataset_id": "text",
        "number_of_checks": 1,
        "relative_coverage_score": "text"
      }
    ]
  }
}