Get Event

Get event with specified identifier.

Get Event

GET https://environment.monterosa.cloud/api/v2/events/:event_id

Path Parameters

Name	Type	Description
event_id	string	Event ID.

Query Parameters

Name	Type	Description
include	string	Include additional relation to the response. For example, include=project adds the related project resource to the response. Possible values: project.
fields[events]	string	Comma-separated list of attribute names. When provided, only the listed attributes are returned in the response. Use to opt in to Optional attributes or to reduce payload size.

Optional attributes

The following attributes are not returned by default. To include them, list their names in the fields[events] query parameter, alongside any other attributes you need.

Attribute	Type	Description
current_concurrency	integer	Number of users currently engaging with the event, fetched in real time.
peak_concurrency	integer	Highest number of concurrent users observed for the event.
interactions	integer	Total number of interactions submitted by users during the event.
unique_users	integer	Number of unique users who took part in the event.
average_session_length	integer	Average length of a user session in the event, in seconds.

The requested attributes appear in the attributes object of the event resource. See Get event with optional attributes for a worked example.

Headers

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

200

{
  "data": {
    "id": "4ba39f91-627f-4668-92be-9519a803e06d",
    "type": "events",
    "attributes": {
      "name": "Event Name",
      "duration": 3600,
      "original_duration": 3600,
      "start_mode": "manual",
      "repeat": false,
      "repeat_in": null,
      "live_stats_uuid": null,
      "on_demand_duration": null,
      "extra_time_duration": null,
      "start_at": 1546290000,
      "start_at_iso": "2018-12-31T21:00:00Z",
      "end_at": 1546293600,
      "end_at_iso": "2018-12-31T22:00:00Z",
      "end_mode": "duration",
      "settings": [
        {
          "key": "bool",
          "values": {
            "all": true
          }
        },
        ......
      ],
      "state": "future",
      "actions": [
        
      ]
    },
    "relationships": {
      "elements": {
        "links": {
          "related": "https://example.lvis.io/api/v2/events/4ba39f91-627f-4668-92be-9519a803e06d/elements"
        }
      },
      "stats": {
        "data": {
          "id": "4ba39f91-627f-4668-92be-9519a803e06d",
          "type": "stats"
        }
      },
      "project": {
        "data": {
          "id": "fe5eba4d-d7b6-408f-a393-39bc8f41d2c5",
          "type": "projects"
        }
      }
    },
    "links": {
      "self": "https://example.lvis.io/api/v2/events/4ba39f91-627f-4668-92be-9519a803e06d"
    }
  }
}

Example

curl --request GET \
  --url https://environment.monterosa.cloud/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323 \
  --header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
  --header 'Content-Type: application/vnd.api+json'

Get event with project

cURL

curl --request GET \
  --url https://environment.monterosa.cloud/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323?include=project \
  --header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
  --header 'Content-Type: application/vnd.api+json'

Response

Get event with optional attributes

cURL

curl --request GET \
  --globoff --url 'https://environment.monterosa.cloud/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323?fields[events]=name,state,current_concurrency,peak_concurrency,interactions,unique_users,average_session_length' \
  --header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
  --header 'Content-Type: application/vnd.api+json'

Response