Get Events

Get all events of a specific project.

Get Events request supports pagination.

Get Events

GET https://environment.monterosa.cloud/api/v2/projects/:project_id/events

Path Parameters

Name	Type	Description
project_id	string	Project ID.

Query Parameters

Name	Type	Description
filter[only_listings]	string	Filter events in order to display only those that are included in listings. Possible values: true, false.
include	string	Include additional relation to the response. For example, include=stats adds event stats to the response. Possible values: stats, project. In order to include more than one relation, provide them separated by commas.
filter[state]*	string	Filter events by state. In order to filter events by multiple states, provide them separated by commas. Possible values: future, current, on_demand, past.
page[cursor]	string	Pagination cursor.
page[count]	integer	Page size.
sort	string	Sorting order. Possible values: start_time (default) - from earlier to later start time, -start_time - from later to earlier start time.

Headers

Name	Type	Description
Authorization	string	Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
Content-Type	string	application/vnd.api+json

200

{
  "data": [
    {
      "id": "a7fde717-6100-4377-8530-fbad083eb768",
      "type": "events",
      "attributes": {
        "name": "Event",
        "duration": 60,
        "start_mode": "manual",
        "state": "future",
        "actions": [],
        "original_duration": 60,
        "repeat": false,
        "repeat_in": null,
        "start_at": 1554392102,
        "start_at_iso": "2019-04-04T15:35:02Z",
        "end_at": 1554392162,
        "end_at_iso": "2019-04-04T15:36:02Z",
        "end_mode": "duration",
        "settings": [
          {
            "key": "text",
            "values": {
              "all": "value"
            }
          },
        ],
        "live_stats_uuid": null,
        "on_demand_duration": null,
        "extra_time_duration": null
      },
      "relationships": {
        "elements": {
          "links": {
            "related": "https://environment.lvis.io/api/v2/events/a7fde717-6100-4377-8530-fbad083eb768/elements"
          }
        },
        "stats": {
          "data": {
            "id": "a7fde717-6100-4377-8530-fbad083eb768",
            "type": "stats"
          }
        },
        "project": {
          "data": {
            "id": "55aecc98-87d4-4c42-b9c9-c8d76e924452",
            "type": "projects"
          }
        }
      },
      "links": {
        "self": "https://environment.lvis.io/api/v2/events/a7fde717-6100-4377-8530-fbad083eb768"
      }
    }
  ],
  "links": {
    "prev": "https://environment.lvis.io/api/v2/projects/55aecc98-87d4-4c42-b9c9-c8d76e924452/events?filter[state]=future&page[count]=20&page[cursor]=eyJmcm9tIjoxNTU0MzkyMTAyMDAwLCJvcmRlciI6InN0YXJ0X3RpbWUiLCJpZCI6Ijg1NyIsImZvcndhcmQiOmZhbHNlfQ",
    "next": "https://environment.lvis.io/api/v2/projects/55aecc98-87d4-4c42-b9c9-c8d76e924452/events?filter[state]=future&page[count]=20&page[cursor]=eyJmcm9tIjoxNTU0MzkyMTAyMDAwLCJvcmRlciI6InN0YXJ0X3RpbWUiLCJpZCI6Ijg1NyIsImZvcndhcmQiOnRydWV9"
  }
}

Example

curl --request GET \
  --globoff --url 'https://environment.monterosa.cloud/api/v2/projects/a7fde717-6100-4377-8530-fbad083eb768/events?filter[only_listings]=true&filter[state]=future' \
  --header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
  --header 'Content-Type: application/vnd.api+json'