ReportsList dashboards

List dashboards

Needs: Reports, Read

Lists report dashboards: id, name, number of insights and whether it is published.

Note: The exact field names for the insight count and published flag follow the dashboard list in Imploy, so the shape shown is an example.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/reports/dashboards?query=example_string&page=25&per_page=25" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    {
      "id": 6,
      "name": "Weekly ops",
      "insights": 3,
      "published": false
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "last_page": 1
  }
}
GET
/reports/dashboards
GET
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.
query
querystring

Match a dashboard name.

query
pageinteger

Page number, 1 or greater.

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.

Query Parameters

querystring

Match a dashboard name.

pageinteger

Page number, 1 or greater.

per_pageinteger

Up to 100.

Responses

OK