Send a dashboard

curl --request POST \
  --url https://api.select.dev/v2/dashboards/{dashboard_id}/actions/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "subject": "<string>",
  "destination_ids": [
    "<string>"
  ],
  "custom_message": "<string>",
  "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"
    }
  ],
  "digest_id": "<string>"
}
'

import requests

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

payload = {
    "subject": "<string>",
    "destination_ids": ["<string>"],
    "custom_message": "<string>",
    "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"
        }
    ],
    "digest_id": "<string>"
}
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({
    subject: '<string>',
    destination_ids: ['<string>'],
    custom_message: '<string>',
    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'
      }
    ],
    digest_id: '<string>'
  })
};

fetch('https://api.select.dev/v2/dashboards/{dashboard_id}/actions/send', 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}/actions/send",
  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([
    'subject' => '<string>',
    'destination_ids' => [
        '<string>'
    ],
    'custom_message' => '<string>',
    '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'
        ]
    ],
    'digest_id' => '<string>'
  ]),
  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}/actions/send"

	payload := strings.NewReader("{\n  \"subject\": \"<string>\",\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\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  \"digest_id\": \"<string>\"\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}/actions/send")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subject\": \"<string>\",\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\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  \"digest_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"subject\": \"<string>\",\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\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  \"digest_id\": \"<string>\"\n}"

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

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

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

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

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

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

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

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

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

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

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

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

POST

dashboards

{dashboard_id}

actions

send

Send a dashboard

curl --request POST \
  --url https://api.select.dev/v2/dashboards/{dashboard_id}/actions/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "subject": "<string>",
  "destination_ids": [
    "<string>"
  ],
  "custom_message": "<string>",
  "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"
    }
  ],
  "digest_id": "<string>"
}
'

import requests

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

payload = {
    "subject": "<string>",
    "destination_ids": ["<string>"],
    "custom_message": "<string>",
    "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"
        }
    ],
    "digest_id": "<string>"
}
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({
    subject: '<string>',
    destination_ids: ['<string>'],
    custom_message: '<string>',
    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'
      }
    ],
    digest_id: '<string>'
  })
};

fetch('https://api.select.dev/v2/dashboards/{dashboard_id}/actions/send', 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}/actions/send",
  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([
    'subject' => '<string>',
    'destination_ids' => [
        '<string>'
    ],
    'custom_message' => '<string>',
    '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'
        ]
    ],
    'digest_id' => '<string>'
  ]),
  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}/actions/send"

	payload := strings.NewReader("{\n  \"subject\": \"<string>\",\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\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  \"digest_id\": \"<string>\"\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}/actions/send")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subject\": \"<string>\",\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\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  \"digest_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"subject\": \"<string>\",\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"custom_message\": \"<string>\",\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  \"digest_id\": \"<string>\"\n}"

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

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

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

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

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

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

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

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

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

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

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

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "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 one-off request to capture a dashboard and deliver it to destinations.

Independent of any digest's schedule. Set digest_id only when this send is triggered from an existing digest's "send now" action, so the delivered message can link back to it.

subject

string

required

The subject line of the delivered message.

Required string length: 1 - 255

destination_ids

string[]

required

The destinations to deliver the dashboard to.

Minimum array length: 1

delivery_format

enum<string>

required

The format the dashboard is captured and delivered in.

Available options:

pdf,

png,

url

custom_message

string | null

A message included alongside the delivered dashboard.

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"
  }
]

digest_id

string | null

The digest this send was triggered from, if any. Included in the delivered message so it links back to that digest's settings.

Response

Accepted. No response body.

Get Started

Endpoints

Send a dashboard

Authorizations

Headers

Path Parameters

Body

Response