Describe a dataset

Parameters

datasetpathrequiredstring

Responses

200Dataset metadata and columns

object

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X GET 'https://v3.revolutionstreetwxs.io/api/v3/export/datasets/orders' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/export/datasets/orders", {
  method: "GET",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://v3.revolutionstreetwxs.io/api/v3/export/datasets/orders",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
)
data = response.json()

Response 200

{
  "name": "Example",
  "label": "label",
  "description": "Example note",
  "source": "postgres",
  "group": "warehouse",
  "permission": "permission",
  "timeColumn": "time column",
  "columns": [
    {
      "name": "Example",
      "type": "type",
      "nullable": true,
      "enumValues": [
        "enum value"
      ]
    }
  ]
}