Sign in

v1

latestOpenAPI 3.0.02026-07-12152226.1 KB
Insights

listInsights

List insights (saved charts) available to the user

get/v1/dashboard/insights

Query parameters

qstring

Free-text search over name/title and description (case-insensitive substring).

visualisation_idVisualisationId[]

Filter insights by one or more visualisation ids.

[
  "timechart"
]
tagsstring[]

Filter by one or more tags (see tags_match for any/all semantics).

tags_match'any' | 'all'

Whether a result must match any (default) or all of the given tags.

created_bystring

Filter by the id of the creating user.

created_afterstring date-time
created_beforestring date-time
updated_afterstring date-time
updated_beforestring date-time
shared_withstring[]

Filter to resources shared with any of the given user ids.

ownerstring[]

Filter to resources owned by any of the given user ids.

accessible_tostring

Filter to resources the given user id may view (owner, shared, org-wide or legacy).

sort'created_at' | 'updated_at' | 'name' | 'title'

Field to sort by. name applies to insights, title to dashboards.

order'asc' | 'desc'

Sort direction. Defaults to ascending (preserving the pre-migration order).

limitinteger

Maximum results to return (max 200). Omit to return all matching results (pagination is opt-in).

offsetinteger

Number of results to skip, for pagination. Use with limit (page N = offset N*limit).

Response

List of insights available to the user

Example response

{
  "results": [
    {
      "created_by": "10598",
      "updated_by": "10598",
      "owner_org_id": "739224",
      "owners": [
        "10598"
      ],
      "shared_with": [
        {
          "user_id": "10598",
          "permission": "view"
        }
      ],
      "id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
      "name": "Opportunities created by journeys every month",
      "description": "Monthly count of opportunities grouped by source journey",
      "visualisation_id": "timechart",
      "visualisation_config": {
        "query": {
          "dataset": "entity_operations",
          "measure": "count_operations",
          "dimensions": [
            {
              "time_with_granularity": "year-month"
            }
          ],
          "filters": [
            {
              "entity_schema": "opportunity"
            }
          ]
        },
        "options": {
          "type": "bar"
        }
      },
      "tags": [
        "revenue",
        "marketing"
      ]
    }
  ]
}