Soda Cloud Reporting API

This API enables you to query reporting-oriented data from your Soda Cloud account. Use this data to power dashboards and reports on the coverage and quality of your data.

Authentication

The API supports authentication via ApiKey (Strongly Recommended) HTTPBasic (Up for deprecation), TokenAuth (Up for Deprecation). Except for the /get_token (up for deprecation) endpoint, which only supports HTTP Basic authentication.

• ApiKey (Strongly Recommended) authentication allows you to use API keys generated in your Cloud Profile. This method is the only one that will work in all cases whether your user is part of more than one organizations, or whether your organization uses Single Sign-On (SSO) authentication. Provide your API Key ID and API Key Secret as X-API-KEY-ID and X-API-KEY-SECRET headers, respectively. If you do not know how to generate your API Key and Secret pair follow the Configure and run Soda Library instructions.

• HTTPBasic (Up for deprecation) authentication requires you to provide your username and password as a Base64 encoded Authorization header. Send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.

• TokenAuth (Up for deprecation) requires that you obtain a Soda token from the /get_token endpoint using your username and password in accordance with the HTTPBasic Authentication framework. This token has an expiration of 30 minutes. The /get_token endpoint makes this clear to you (see endpoint documentation below). You can then use this token to authenticate with any of the other endpoints.

Examples

ApiKey (Strongly Recommended)

curl --request POST \
  --url https://reporting.cloud.soda.io/v1/coverage/dataset_coverage \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY-ID: 60ef2406-6492-4236-a6b8-2cb9240d803c' \
  --header 'X-API-KEY-SECRET: 918TcsFViYYEBtXlbzMeX6lT4SVm70'

HTTPBasic (Up for Deprecation)

curl --request POST \
  --url https://reporting.cloud.soda.io/v1/coverage/dataset_coverage \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic bXl1c2VybmFtZUBzb2RhLmlvOm15c2VjcmV0cGFzc3dvcmQ='

TokenAuth (Up for Deprecation)

curl --request POST \
  --url https://reporting.cloud.soda.io/v1/coverage/dataset_coverage \
  --header 'Content-Type: application/json' \
  --header 'SODA_TOKEN: ZAT2BM4sceKCGggHfawz_Ji5cfHKkiPjoN123yM0wCrWaxSkN4CGdg'