EPepilot
Examples

listAvailableExamples

Changed on

Returns list of available exampless for visualisations to configure new dashboard tiles

get/v1/dashboard/examples

Request

  • Base URL
    https://dashboard.sls.epilot.io
  • URL
    https://dashboard.sls.epilot.io/v1/dashboard/examples
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Response

List of available exampless for visualisations to configure new dashboard tiles

Example response

{
  "results": [
    {
      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",
      "title": "Number of opportunities created by journeys every month",
      "visualisation": "timechart",
      "query": {
        "dataset": "entity_operations",
        "measure": "count_operations",
        "dimensions": [
          {
            "time_with_granularity": "year-month"
          }
        ],
        "filters": [
          {
            "entity_schema": "opportunity"
          }
        ]
      }
    }
  ]
}

Changes

  • 43a3a9a1c8acRevision changes
    • warning

      added the new notes enum value to the // response property for the response status