Event properties

Event properties are list of available properties for events resource.

Available methods

All available methods for resource event properties.

HTTP method Endpoint Description
[badge-blue GET] /event-properties Get information about all event properties
[badge-blue GET] /event-properties/{event_property_id} Get information about an event property


Get all event properties

Get information about event properties
[badge-blue GET] /event-properties

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Name for the property No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
event_properties Property[] List of all event properties
total_items integer Count of all found event properties

Example Request

GET https://<projectURL>/rest-api/customer-interface/v1.0/event-properties?count=3
Cache-Control: no-cache
Authorization: Basic Y3VzdG9tZXJfaW50ZXJmYWNlOjIwOTM1Y2QyMNzcyYjY0ZGQ1NzJmNWIyZDEzYWNlZTc5ZTU4ZGY5MGJmYTFiNzRlYzFiNTU3OGEwYg==
Content-Type: application/json

Example response

HTTP/1.1 200 OK
Date: Wed, 14 Apr 2021 08:25:51 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "event_properties": [
      {
        "property_id": "account_registration_contact_source",
        "name": "Account source",
        "description": null,
        "data_type": "multiselect",
        "items": [],
        "is_required": 0,
        "is_unique": 0,
        "last_change": "2018-09-07 10:58:49.106935",
        "state": 1
      },
      {
        "property_id": "account_updated_columns",
        "name": "Updated columns on account",
        "description": null,
        "data_type": "multiselect",
        "items": [],
        "is_required": 0,
        "is_unique": 0,
        "last_change": "2021-03-04 18:02:24.990684",
        "state": 1
      },
      {
        "property_id": "applying_voucher_voucher_type",
        "name": "Voucher Type",
        "description": "",
        "data_type": "multiselect",
        "items": [
          {
            "id": "8fd73167342d0689c4c015320",
            "name": "{\"en\":\"evening\",\"cz\":\"vecer\"}",
            "state": 1
          },
          {
            "id": "86e05affc7a7abefcd51ab400",
            "name": "{\"en\":\"day\",\"cz\":\"den\"}",
            "state": 1
          },
          {
            "id": "8bed991c68a470e7aaefbf048",
            "name": "{\"en\":\"night\",\"cz\":\"noc\"}",
            "state": 1
          },
          {
            "id": "81eaeea13b8984a169c40a325",
            "name": "{\"en\":\"morning\",\"cz\":\"rano\"}",
            "state": 1
          }
        ],
        "is_required": 0,
        "is_unique": 0,
        "last_change": "2021-02-17 09:57:57",
        "state": 1
      }
    ],
    "total_items": 3
  }
}


Get a event property

Get information about a specific event property
[badge-blue GET] /event-properties/{event_property_id}

Path parameters

Parameter name Type Description
event_property_id string The unique id for the event property

Response

Status code: 200 OK
Output structure : Property

Example Request

GET https://<projectURL>/rest-api/customer-interface/v1.0/event-properties/account_registration_contact_source
Cache-Control: no-cache
Authorization: Basic Y3VzdG9tZXJfaW50ZXJmYWNlOjIwOTM1Y2QyNzcyYjY0ZGQ1NzJmNWIyZDEzYWNlZTc5ZTU4ZGY5MGJmYTFiNzRlYzFiNTU3OGEwYg==
Content-Type: application/json

Example response

HTTP/1.1 200 OK
Date: Wed, 14 Apr 2021 09:08:41 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "property_id": "account_registration_contact_source",
    "name": "Account source",
    "description": null,
    "data_type": "multiselect",
    "items": [],
    "is_required": 0,
    "is_unique": 0,
    "last_change": "2018-09-07 10:58:49.106935",
    "state": 1
  }
}