Create a dashboard digest

curl --request POST \
  --url https://api.select.dev/v2/dashboards/{dashboard_id}/digests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "schedule": {
    "frequency": "daily"
  },
  "destination_ids": [
    "<string>"
  ],
  "custom_message": "<string>",
  "state": "active",
  "filters": [
    {
      "field": "warehouse_name",
      "operator": "in",
      "values": [
        "TRANSFORMING"
      ]
    },
    {
      "field": "user_name",
      "operator": "is not"
    },
    {
      "filters": [
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "ANALYTICS"
          ]
        },
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "RAW"
          ]
        }
      ],
      "operator": "or"
    }
  ]
}
'

import requests

url = "https://api.select.dev/v2/dashboards/{dashboard_id}/digests"

payload = {
    "name": "<string>",
    "schedule": { "frequency": "daily" },
    "destination_ids": ["<string>"],
    "custom_message": "<string>",
    "state": "active",
    "filters": [
        {
            "field": "warehouse_name",
            "operator": "in",
            "values": ["TRANSFORMING"]
        },
        {
            "field": "user_name",
            "operator": "is not"
        },
        {
            "filters": [
                {
                    "field": "database_name",
                    "operator": "in",
                    "values": ["ANALYTICS"]
                },
                {
                    "field": "database_name",
                    "operator": "in",
                    "values": ["RAW"]
                }
            ],
            "operator": "or"
        }
    ]
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    schedule: {frequency: 'daily'},
    destination_ids: ['<string>'],
    custom_message: '<string>',
    state: 'active',
    filters: [
      {field: 'warehouse_name', operator: 'in', values: ['TRANSFORMING']},
      {field: 'user_name', operator: 'is not'},
      {
        filters: [
          {field: 'database_name', operator: 'in', values: ['ANALYTICS']},
          {field: 'database_name', operator: 'in', values: ['RAW']}
        ],
        operator: 'or'
      }
    ]
  })
};

fetch('https://api.select.dev/v2/dashboards/{dashboard_id}/digests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.select.dev/v2/dashboards/{dashboard_id}/digests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'schedule' => [
        'frequency' => 'daily'
    ],
    'destination_ids' => [
        '<string>'
    ],
    'custom_message' => '<string>',
    'state' => 'active',
    'filters' => [
        [
                'field' => 'warehouse_name',
                'operator' => 'in',
                'values' => [
                                'TRANSFORMING'
                ]
        ],
        [
                'field' => 'user_name',
                'operator' => 'is not'
        ],
        [
                'filters' => [
                                [
                                                                'field' => 'database_name',
                                                                'operator' => 'in',
                                                                'values' => [
                                                                                                                                'ANALYTICS'
                                                                ]
                                ],
                                [
                                                                'field' => 'database_name',
                                                                'operator' => 'in',
                                                                'values' => [
                                                                                                                                'RAW'
                                                                ]
                                ]
                ],
                'operator' => 'or'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.select.dev/v2/dashboards/{dashboard_id}/digests"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"schedule\": {\n    \"frequency\": \"daily\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\n  \"state\": \"active\",\n  \"filters\": [\n    {\n      \"field\": \"warehouse_name\",\n      \"operator\": \"in\",\n      \"values\": [\n        \"TRANSFORMING\"\n      ]\n    },\n    {\n      \"field\": \"user_name\",\n      \"operator\": \"is not\"\n    },\n    {\n      \"filters\": [\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"ANALYTICS\"\n          ]\n        },\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"RAW\"\n          ]\n        }\n      ],\n      \"operator\": \"or\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.select.dev/v2/dashboards/{dashboard_id}/digests")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"schedule\": {\n    \"frequency\": \"daily\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\n  \"state\": \"active\",\n  \"filters\": [\n    {\n      \"field\": \"warehouse_name\",\n      \"operator\": \"in\",\n      \"values\": [\n        \"TRANSFORMING\"\n      ]\n    },\n    {\n      \"field\": \"user_name\",\n      \"operator\": \"is not\"\n    },\n    {\n      \"filters\": [\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"ANALYTICS\"\n          ]\n        },\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"RAW\"\n          ]\n        }\n      ],\n      \"operator\": \"or\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/dashboards/{dashboard_id}/digests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"schedule\": {\n    \"frequency\": \"daily\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\n  \"state\": \"active\",\n  \"filters\": [\n    {\n      \"field\": \"warehouse_name\",\n      \"operator\": \"in\",\n      \"values\": [\n        \"TRANSFORMING\"\n      ]\n    },\n    {\n      \"field\": \"user_name\",\n      \"operator\": \"is not\"\n    },\n    {\n      \"filters\": [\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"ANALYTICS\"\n          ]\n        },\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"RAW\"\n          ]\n        }\n      ],\n      \"operator\": \"or\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "dashboard_id": "<string>",
  "name": "<string>",
  "schedule": {
    "frequency": "daily"
  },
  "delivery_format": "pdf",
  "destination_ids": [
    "<string>"
  ],
  "destinations": [
    {
      "id": "<string>",
      "type": "slack",
      "label": "<string>"
    }
  ],
  "created_by": "<string>",
  "create_time": "<string>",
  "update_time": "<string>",
  "etag": "<string>",
  "custom_message": "<string>",
  "state": "active",
  "filters": [
    {
      "field": "warehouse_name",
      "operator": "in",
      "values": [
        "TRANSFORMING"
      ]
    },
    {
      "field": "user_name",
      "operator": "is not"
    },
    {
      "filters": [
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "ANALYTICS"
          ]
        },
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "RAW"
          ]
        }
      ],
      "operator": "or"
    }
  ],
  "latest_run": {
    "id": "<string>",
    "status": "running",
    "start_time": "<string>",
    "scheduled_date": "<string>",
    "end_time": "<string>"
  }
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

POST

dashboards

{dashboard_id}

digests

Create a dashboard digest

curl --request POST \
  --url https://api.select.dev/v2/dashboards/{dashboard_id}/digests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "schedule": {
    "frequency": "daily"
  },
  "destination_ids": [
    "<string>"
  ],
  "custom_message": "<string>",
  "state": "active",
  "filters": [
    {
      "field": "warehouse_name",
      "operator": "in",
      "values": [
        "TRANSFORMING"
      ]
    },
    {
      "field": "user_name",
      "operator": "is not"
    },
    {
      "filters": [
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "ANALYTICS"
          ]
        },
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "RAW"
          ]
        }
      ],
      "operator": "or"
    }
  ]
}
'

import requests

url = "https://api.select.dev/v2/dashboards/{dashboard_id}/digests"

payload = {
    "name": "<string>",
    "schedule": { "frequency": "daily" },
    "destination_ids": ["<string>"],
    "custom_message": "<string>",
    "state": "active",
    "filters": [
        {
            "field": "warehouse_name",
            "operator": "in",
            "values": ["TRANSFORMING"]
        },
        {
            "field": "user_name",
            "operator": "is not"
        },
        {
            "filters": [
                {
                    "field": "database_name",
                    "operator": "in",
                    "values": ["ANALYTICS"]
                },
                {
                    "field": "database_name",
                    "operator": "in",
                    "values": ["RAW"]
                }
            ],
            "operator": "or"
        }
    ]
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    schedule: {frequency: 'daily'},
    destination_ids: ['<string>'],
    custom_message: '<string>',
    state: 'active',
    filters: [
      {field: 'warehouse_name', operator: 'in', values: ['TRANSFORMING']},
      {field: 'user_name', operator: 'is not'},
      {
        filters: [
          {field: 'database_name', operator: 'in', values: ['ANALYTICS']},
          {field: 'database_name', operator: 'in', values: ['RAW']}
        ],
        operator: 'or'
      }
    ]
  })
};

fetch('https://api.select.dev/v2/dashboards/{dashboard_id}/digests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.select.dev/v2/dashboards/{dashboard_id}/digests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'schedule' => [
        'frequency' => 'daily'
    ],
    'destination_ids' => [
        '<string>'
    ],
    'custom_message' => '<string>',
    'state' => 'active',
    'filters' => [
        [
                'field' => 'warehouse_name',
                'operator' => 'in',
                'values' => [
                                'TRANSFORMING'
                ]
        ],
        [
                'field' => 'user_name',
                'operator' => 'is not'
        ],
        [
                'filters' => [
                                [
                                                                'field' => 'database_name',
                                                                'operator' => 'in',
                                                                'values' => [
                                                                                                                                'ANALYTICS'
                                                                ]
                                ],
                                [
                                                                'field' => 'database_name',
                                                                'operator' => 'in',
                                                                'values' => [
                                                                                                                                'RAW'
                                                                ]
                                ]
                ],
                'operator' => 'or'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.select.dev/v2/dashboards/{dashboard_id}/digests"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"schedule\": {\n    \"frequency\": \"daily\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\n  \"state\": \"active\",\n  \"filters\": [\n    {\n      \"field\": \"warehouse_name\",\n      \"operator\": \"in\",\n      \"values\": [\n        \"TRANSFORMING\"\n      ]\n    },\n    {\n      \"field\": \"user_name\",\n      \"operator\": \"is not\"\n    },\n    {\n      \"filters\": [\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"ANALYTICS\"\n          ]\n        },\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"RAW\"\n          ]\n        }\n      ],\n      \"operator\": \"or\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.select.dev/v2/dashboards/{dashboard_id}/digests")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"schedule\": {\n    \"frequency\": \"daily\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\n  \"state\": \"active\",\n  \"filters\": [\n    {\n      \"field\": \"warehouse_name\",\n      \"operator\": \"in\",\n      \"values\": [\n        \"TRANSFORMING\"\n      ]\n    },\n    {\n      \"field\": \"user_name\",\n      \"operator\": \"is not\"\n    },\n    {\n      \"filters\": [\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"ANALYTICS\"\n          ]\n        },\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"RAW\"\n          ]\n        }\n      ],\n      \"operator\": \"or\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/dashboards/{dashboard_id}/digests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"schedule\": {\n    \"frequency\": \"daily\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\n  \"state\": \"active\",\n  \"filters\": [\n    {\n      \"field\": \"warehouse_name\",\n      \"operator\": \"in\",\n      \"values\": [\n        \"TRANSFORMING\"\n      ]\n    },\n    {\n      \"field\": \"user_name\",\n      \"operator\": \"is not\"\n    },\n    {\n      \"filters\": [\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"ANALYTICS\"\n          ]\n        },\n        {\n          \"field\": \"database_name\",\n          \"operator\": \"in\",\n          \"values\": [\n            \"RAW\"\n          ]\n        }\n      ],\n      \"operator\": \"or\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "dashboard_id": "<string>",
  "name": "<string>",
  "schedule": {
    "frequency": "daily"
  },
  "delivery_format": "pdf",
  "destination_ids": [
    "<string>"
  ],
  "destinations": [
    {
      "id": "<string>",
      "type": "slack",
      "label": "<string>"
    }
  ],
  "created_by": "<string>",
  "create_time": "<string>",
  "update_time": "<string>",
  "etag": "<string>",
  "custom_message": "<string>",
  "state": "active",
  "filters": [
    {
      "field": "warehouse_name",
      "operator": "in",
      "values": [
        "TRANSFORMING"
      ]
    },
    {
      "field": "user_name",
      "operator": "is not"
    },
    {
      "filters": [
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "ANALYTICS"
          ]
        },
        {
          "field": "database_name",
          "operator": "in",
          "values": [
            "RAW"
          ]
        }
      ],
      "operator": "or"
    }
  ],
  "latest_run": {
    "id": "<string>",
    "status": "running",
    "start_time": "<string>",
    "scheduled_date": "<string>",
    "end_time": "<string>"
  }
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Organization API key (sl_…).

Headers

x-tenant-id

string

required

The organization ID the request is scoped to.

Path Parameters

dashboard_id

string

required

Body

application/json

A digest to create on a dashboard.

name

string

required

Required string length: 1 - 255

schedule

DailySchedule · object

required

DailySchedule
WeeklySchedule
MonthlySchedule

Show child attributes

delivery_format

enum<string>

required

Available options:

pdf,

png,

url

destination_ids

string[]

required

The destinations the digest delivers to, by the ids /v2/destinations returns.

Minimum array length: 1

custom_message

string | null

state

enum<string>

default:active

Available options:

active,

paused

filters

Filters · object[] | null

Filters applied to the dashboard when it is captured, in place of the dashboard's own saved filters. Omit this field or set it to null to capture the dashboard with its saved filters; set it to an empty array to capture the dashboard with no filters at all. Each entry names a field, an operator, and the value or values to compare against, and entries are combined with AND; an entry may instead be an and/or group containing its own entries in the same form. The operators available are the ones the dashboard's filter controls offer. A filter naming a field that none of the dashboard's blocks expose has no effect on the capture.

Example:

[
  {
    "field": "warehouse_name",
    "operator": "in",
    "values": ["TRANSFORMING"]
  },
  {
    "field": "user_name",
    "operator": "is not"
  },
  {
    "filters": [
      {
        "field": "database_name",
        "operator": "in",
        "values": ["ANALYTICS"]
      },
      {
        "field": "database_name",
        "operator": "in",
        "values": ["RAW"]
      }
    ],
    "operator": "or"
  }
]

Response

Successful Response

A schedule that captures a dashboard and delivers it to destinations.

string

required

read-only

The unique identifier of the digest.

dashboard_id

string

required

read-only

The dashboard this digest captures and delivers.

name

string

required

The display name of the digest.

schedule

DailySchedule · object

required

How often the digest is delivered.

DailySchedule
WeeklySchedule
MonthlySchedule

Show child attributes

delivery_format

enum<string>

required

The format the dashboard is captured and delivered in.

Available options:

pdf,

png,

url

destination_ids

string[]

required

The destinations the digest delivers to, by the ids /v2/destinations returns.

destinations

DigestDestination · object[]

required

read-only

The destinations the digest delivers to, with display details.

Show child attributes

created_by

string

required

read-only

The identifier of the user or API key that created the digest.

create_time

string

required

read-only

When the digest was created, as an RFC 3339 UTC timestamp.

update_time

string

required

read-only

When the digest was last changed, as an RFC 3339 UTC timestamp.

etag

string

required

read-only

Opaque strong ETag. Supply it in an If-Match header when changing or deleting the digest.

custom_message

string | null

A message included alongside the delivered dashboard.

state

enum<string>

default:active

Whether the digest is actively delivering on its schedule or paused.

Available options:

active,

paused

filters

any[] | null

Example:

[
  {
    "field": "warehouse_name",
    "operator": "in",
    "values": ["TRANSFORMING"]
  },
  {
    "field": "user_name",
    "operator": "is not"
  },
  {
    "filters": [
      {
        "field": "database_name",
        "operator": "in",
        "values": ["ANALYTICS"]
      },
      {
        "field": "database_name",
        "operator": "in",
        "values": ["RAW"]
      }
    ],
    "operator": "or"
  }
]

latest_run

DigestRun · object | null

The most recent attempt to run this digest, if any.

Show child attributes

Get Started

Endpoints

Create a dashboard digest

Authorizations

Headers

Path Parameters

Body

Response