ReportsCreate a dashboard

Create a dashboard

Needs: Reports, Read-write

Creates a report dashboard with insight and text cards. Cards go two per row (half width each, metrics and text included) unless you give a position.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/reports/dashboards" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "Weekly ops",
  "settings": {
    "spacing": "comfortable",
    "refresh_minutes": 15
  },
  "cards": [
    {
      "insight_id": 31,
      "show_title": true
    },
    {
      "text": "Hours are completed shifts only."
    }
  ]
}'
{
  "created": 6,
  "...": "the dashboard, its link and cards"
}
POST
/reports/dashboards
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

The dashboard name.

descriptionstring

What it shows.

settingsobject

spacing (compact, comfortable or spacious), show_card_headers, auto_layout, auto_save and refresh_minutes (0, 5, 10, 15 or 30).

cardsarray

Cards in order. Each is {insight_id} or {text}, with optional show_title, show_description and position. A position is {col, row, width, height} on a 36-column grid, and is only needed for a different size or spot.

space_idinteger

Put it in this space.

subfolder_idstring

A subfolder within space_id.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Body

application/json
namestring
Required

The dashboard name.

descriptionstring

What it shows.

settingsobject

spacing (compact, comfortable or spacious), show_card_headers, auto_layout, auto_save and refresh_minutes (0, 5, 10, 15 or 30).

cardsarray

Cards in order. Each is {insight_id} or {text}, with optional show_title, show_description and position. A position is {col, row, width, height} on a 36-column grid, and is only needed for a different size or spot.

space_idinteger

Put it in this space.

subfolder_idstring

A subfolder within space_id.

Responses