---
title: "Describe Datasource"
method: GET
path: "/v1/datasources/{datasource_id}/describe"
tags: ["Datasources"]
---

# Describe Datasource

`GET /v1/datasources/{datasource_id}/describe`

## Request

- Base URL: `https://api.oviond.com`
- URL: `https://api.oviond.com/v1/datasources/{datasource_id}/describe`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Describe one datasource the way the report builder sees it: its data views (with the `advanced` keys each view requires), its default view and defaults, and its metric and dimension catalogs carrying the flags that decide what can be combined (`single` — must be the only dimension; `requires_metric` — only offered once that metric is picked; `deprecated`; `custom`). A metric or dimension is only valid inside its own `data_view`. Pass `data_view` to scope the response to one view.

## Path parameters

- `datasource_id` 'advanced-web-ranking' | 'ac' | 'adroll' | 'ahrefs' | 'basecamp' | 'brightlocal' | 'call-rail' | 'drip' | 'keywords' | 'sendin-blue' | 'sendgrid' | 'moosend' | 'mailer-lite' | 'pingdom' | 'uptime-robot' | 'piwik-pro' | 'wordpress' | 'pabbly-connect' | 'ment' | 'twilio' | 'switchy' | 'vimeo' | 'pinterest' | 'pinterest-ads' | 'gtres' | 'paypal' | 'gps' | 'gs' | 'CUSTOM_IMPORT' | 'CUSTOM_DATA' | 'CALCULATION' | 'GOALS' | 'str' | 'wistia' | 'ca-mon' | 'convertkit' | 'woocommerce' | 'xero' | 'matomo' | 'go-high-level' | 'wcs' | 'bing-webmaster-tools' | 'pipedrive' | 'salesforce' | 'tiktok' | 'tiktok-ads' | 'twr' | 'twr-ads' | 'spf' | 'ytbe' | 'google-local-services-ads' | 'klaviyo' | 'gsh' | 'ga4' | 'lkdin-ads' | 'lkdin-pg' | 'mlchmp' | 'inst-ads' | 'inst' | 'fb-ads' | 'fb-pg' | 'gmb' | 'serpstat' | 'hubspot' | 'gadw' | 'sem-rush' | 'se-ranking' | 'microsoft-ads' | 'plausible' | 'snapchat-ads' | 'microsoft-clarity' | 'serp-watch' | 'vbout' | 'moz' | 'chatgpt-ads' | 'omnisend' | 'airtable' | 'nozzle' | 'surnex' | 'jira' | 'clickup' | 'make' | 'freshdesk' | 'chart-mogul' | 'amplitude' | 'harvest' | 'zoho-crm' | 'clockify' | 'adtraction' | 'shopify' | 'copper' | 'help-scout-docs' | 'close-crm' | 'simplesat' | 'help-scout-mailbox', required

## Query parameters

- `data_view` string

## Response `200`

Data views, required advanced keys, and the field catalogs

- DataProxyResponse
  - `success` true, required
  - `data` unknown
  - `meta` unknown

## Other responses

- `404`: Unknown datasource

## Changes

- **2026-10-20** `4cb0a07daf41`: 1 breaking
  - removed the enum value `amazon-advertising` from the `path` request parameter `datasource_id`

[Operation history](https://skmtc.dev/oviond/apis/oviond-backend-api/changes/v1/datasources/:datasource_id/describe/get.md)

---

[API](https://skmtc.dev/oviond/apis/oviond-backend-api.md) · [All operations](https://skmtc.dev/oviond/apis/oviond-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/oviond/apis/oviond-backend-api/revisions/4cb0a07daf41?raw)