Calendar Event API

This article provides sample API calls to manipulate Calendar Events.

PRE-REQUISITES:

1. Fetch Event Calendar information

Fetch Event Calendar information

Retrieve information about all or specific Event Calendars created in the system.

  1. Item: event_calendar
  2. Method: GET
  3. ID: Leave this field empty to get the list of all event calendars created in the system or define the ID of a specific Event Calendar. The ID of the Event Calendar can be found at the Event Calendar Editor web link (at Admin > Event Calendars > select an Event Calendar from the list):
https://demo.metricinsights.com/editor/eventcalendar/edit/event/7
  1. Run request

1.1. Create Event Calendar

Create Event Calendar
  1. Item: event_calendar
  2. Method: POST
  3. ID: Define ID of an Event Calendar that should serve as a foundation for the new calendar. The ID of the Event Calendar can be found at the Event Calendar Editor web link (at Admin > Event Calendars > select an Event Calendar from the list):
https://demo.metricinsights.com/editor/eventcalendar/edit/event/7
  1. Define parameters of a new Event Calendar
  2. Run request

2. Fetch all Events of the specific Event Calendar

Fetch all Events of the specific Event Calendar

Retrieve information about all or specific Event Calendars created in the system.

  1. Item: event
  2. Method: GET
  3. event_calendar: Define the ID of the Event Calendar to retrieve its events. The ID of the Event Calendar can be found at the Event Calendar Editor web link (at Admin > Event Calendars > select an Event Calendar from the list):
https://demo.metricinsights.com/editor/eventcalendar/edit/event/7
  1. Run request

3. Create Event

Create Event
  1. Item: event
  2. Method: POST
  3. ID: Define ID of the Event that should serve as a foundation for the new event. To find an ID of an Event, see Step 2.
  4. Define parameters of a new Event Event. NOTE: Dimension Value "-1" defines ALL values of a given dimension.
  5. Run request

4. Delete Event

Delete Event
  1. Item: event
  2. Method: DELETE
  3. ID: Define ID of the Event you need to delete. To find an ID of an Event, see Step 2.
  4. Run request