Skip to content

Get Insights Dynamic Dashboards

Request

Returns a list of Dynamic Account Insights Mappings (i.e. Insights dynamic dashboards) that are visible to the authenticated user.

This endpoint returns structured Account Insights Mapping objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the account_insights_mappings top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • access_groups (AccessGroup) - Retrieves the Access Groups the dashboard has been shared with. The response will include access_group_ids, which references the data in the access_groups top-level key.
matchingstring

Filter for dashboards with a name that match the specified string. This filter is not case sensitive.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: alphabetical:asc, alphabetical:desc, updated_at:asc, and updated_at:desc.

Default:"alphabetical:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
standardboolean

Return only standard dashboards (true) or only custom dashboards (false).

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/account_insights_mappings/dynamic?include=string&matching=string&only=string&order=alphabetical%3Aasc&page=1&per_page=20&standard=true'

Responses

A list of Account Insights Mappings have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
account_insights_mappingsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "account_insights_mappings": {
    "property1": {
      "access_group_ids": [
        "string"
      ],
      "creator": "string",
      "dynamic": true,
      "is_custom_dashboard": true,
      "name": "string"
    },
    "property2": {
      "access_group_ids": [
        "string"
      ],
      "creator": "string",
      "dynamic": true,
      "is_custom_dashboard": true,
      "name": "string"
    }
  }
}