metabase.api.pulse

Liking cljdoc? Tell your friends :D

Clojure only.

check-card-read-permissions
DELETE_:id
GET_
GET_:id
GET_form_input
GET_preview_card_:id
GET_preview_card_info_:id
GET_preview_card_png_:id
POST_
POST_test
PUT_:id
routes

/api/pulse endpoints.

/api/pulse endpoints.

raw docstring

check-card-read-permissions^clj

(check-card-read-permissions cards)

Users can only create a pulse for cards they have access to.

Users can only create a pulse for `cards` they have access to.

source raw docstring

DELETE_:id^clj

`DELETE /api/pulse/:id`

Delete a Pulse. (DEPRECATED -- don't delete a Pulse anymore -- archive it instead.)

PARAMS:

id

## `DELETE /api/pulse/:id`

Delete a Pulse. (DEPRECATED -- don't delete a Pulse anymore -- archive it instead.)

##### PARAMS:

*  **`id`**

source raw docstring

GET_^clj

`GET /api/pulse/`

Fetch all Pulses

PARAMS:

archived value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

## `GET /api/pulse/`

Fetch all Pulses

##### PARAMS:

*  **`archived`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

source raw docstring

GET_:id^clj

`GET /api/pulse/:id`

Fetch Pulse with ID.

PARAMS:

id

## `GET /api/pulse/:id`

Fetch `Pulse` with ID.

##### PARAMS:

*  **`id`**

source raw docstring

GET_form_input^clj

`GET /api/pulse/form_input`

Provides relevant configuration information and user choices for creating/updating Pulses.

## `GET /api/pulse/form_input`

Provides relevant configuration information and user choices for creating/updating Pulses.

source raw docstring

GET_preview_card_:id^clj

`GET /api/pulse/preview_card/:id`

Get HTML rendering of a Card with id.

PARAMS:

id

## `GET /api/pulse/preview_card/:id`

Get HTML rendering of a Card with `id`.

##### PARAMS:

*  **`id`**

source raw docstring

GET_preview_card_info_:id^clj

`GET /api/pulse/preview_card_info/:id`

Get JSON object containing HTML rendering of a Card with id and other information.

PARAMS:

id

## `GET /api/pulse/preview_card_info/:id`

Get JSON object containing HTML rendering of a Card with `id` and other information.

##### PARAMS:

*  **`id`**

source raw docstring

GET_preview_card_png_:id^clj

`GET /api/pulse/preview_card_png/:id`

Get PNG rendering of a Card with id.

PARAMS:

id

## `GET /api/pulse/preview_card_png/:id`

Get PNG rendering of a Card with `id`.

##### PARAMS:

*  **`id`**

source raw docstring

POST_^clj

`POST /api/pulse/`

Create a new Pulse.

PARAMS:

name value must be a non-blank string.
cards value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys (collection_id, description, display, id, include_csv, include_xls, name) 2) value must be a map with the keys id, include_csv, and include_xls. The array cannot be empty.
channels value must be an array. Each value must be a map. The array cannot be empty.
skip_if_empty value may be nil, or if non-nil, value must be a boolean.
collection_id value may be nil, or if non-nil, value must be an integer greater than zero.
collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

## `POST /api/pulse/`

Create a new `Pulse`.

##### PARAMS:

*  **`name`** value must be a non-blank string.

*  **`cards`** value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name)` 2) value must be a map with the keys `id`, `include_csv`, and `include_xls`. The array cannot be empty.

*  **`channels`** value must be an array. Each value must be a map. The array cannot be empty.

*  **`skip_if_empty`** value may be nil, or if non-nil, value must be a boolean.

*  **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero.

*  **`collection_position`** value may be nil, or if non-nil, value must be an integer greater than zero.

source raw docstring

POST_test^clj

`POST /api/pulse/test`

Test send an unsaved pulse.

PARAMS:

name value must be a non-blank string.
cards value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys (collection_id, description, display, id, include_csv, include_xls, name) 2) value must be a map with the keys id, include_csv, and include_xls. The array cannot be empty.
channels value must be an array. Each value must be a map. The array cannot be empty.
skip_if_empty value may be nil, or if non-nil, value must be a boolean.
collection_id value may be nil, or if non-nil, value must be an integer greater than zero.
collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

## `POST /api/pulse/test`

Test send an unsaved pulse.

##### PARAMS:

*  **`name`** value must be a non-blank string.

*  **`cards`** value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name)` 2) value must be a map with the keys `id`, `include_csv`, and `include_xls`. The array cannot be empty.

*  **`channels`** value must be an array. Each value must be a map. The array cannot be empty.

*  **`skip_if_empty`** value may be nil, or if non-nil, value must be a boolean.

*  **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero.

*  **`collection_position`** value may be nil, or if non-nil, value must be an integer greater than zero.

source raw docstring

PUT_:id^clj

`PUT /api/pulse/:id`

Update a Pulse with id.

PARAMS:

id
name value may be nil, or if non-nil, value must be a non-blank string.
cards value may be nil, or if non-nil, value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys (collection_id, description, display, id, include_csv, include_xls, name) 2) value must be a map with the keys id, include_csv, and include_xls. The array cannot be empty.
channels value may be nil, or if non-nil, value must be an array. Each value must be a map. The array cannot be empty.
skip_if_empty value may be nil, or if non-nil, value must be a boolean.
collection_id value may be nil, or if non-nil, value must be an integer greater than zero.
archived value may be nil, or if non-nil, value must be a boolean.
pulse-updates

## `PUT /api/pulse/:id`

Update a Pulse with `id`.

##### PARAMS:

*  **`id`** 

*  **`name`** value may be nil, or if non-nil, value must be a non-blank string.

*  **`cards`** value may be nil, or if non-nil, value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name)` 2) value must be a map with the keys `id`, `include_csv`, and `include_xls`. The array cannot be empty.

*  **`channels`** value may be nil, or if non-nil, value must be an array. Each value must be a map. The array cannot be empty.

*  **`skip_if_empty`** value may be nil, or if non-nil, value must be a boolean.

*  **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero.

*  **`archived`** value may be nil, or if non-nil, value must be a boolean.

*  **`pulse-updates`**

source raw docstring

routes^clj

Ring routes for api/pulse: (POST_ PUT_:id GET_preview_card_:id POST_test GET_preview_card_png_:id GET_form_input GET_ GET_preview_card_info_:id DELETE_:id GET_:id)

Ring routes for api/pulse:
(POST_ PUT_:id GET_preview_card_:id POST_test GET_preview_card_png_:id GET_form_input GET_ GET_preview_card_info_:id DELETE_:id GET_:id)

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close