Get Events Meta

Retrieves the specified event's metadata.

Metadata refers to information about data. This API retrieves metadata for a specified event by using the event name. It fetches the details of the event's schema or structure as defined during its creation, detailing the various fields and their attributes.

API endpoint example

`https://eu.api.capillarytech.com/v2/events/meta?event_name=be_reserved

Prerequisites

  • Authentication: Basic or OAuth credentials
  • Access group resource: Read access on Behavioural Events resource

Resource information

URI/events/meta
HTTP methodGET
Pagination supported?NA
Rate limitNA
Batch supportNA

Query parameter

Parameter (Parameters marked with * are mandatory)Description
event_name*Name of the event for which the metadata is retrieved.
curl --location 'https://eu.api.capillarytech.com/v2/events/meta?event_name=be_reserved' \
--header 'Authorization: Basic mY2OWZmZmRkYg==' \
--header 'Cookie: _cfuvid=RY6QOmEmXhlkpkYzUT5aGlkDXWcSpLGwMXEa7suetWY-1719207183918-0.0.1.1-604800000'

Response parameters

ParameterDatatypeDescription
clickEventsMetaObjectObject containing metadata related to the event.
- eventIdStringUnique identifier generated for the event at the time of its creation.
- eventNameStringName of the event.
- eventTypeStringSpecifies what the event is related to. Values: USEREVENT, PRODUCTEVENT, COUPONEVENT
- actionsObjectObject containing a list of event handlers that process the event.
- fieldsObjectObject containing the details of the fields of the event.
-- nameStringName of the field.
-- typeStringData type or data related to the field. Example: STRING, DOUBLE, CUSTOMER
-- attributesObjectAttributes associated with the field.
--- accountIdObjectObject containing customer account-related information for the field.
---- valueTypeStringData type of the accountIdfield value. For example, Boolean, Enum, String.
--- addCustomerIfNotExistsObjectObject containing information for adding customers if they do not exist.
---- valueBooleanSpecifies if customers should be added if they do not exist.
Values: True -If customers do not exist, they are created.
False - If customers do not exist, they are not created.
---- valueTypeStringData type of the addCustomerIfNotExists field value. For example, Boolean, Enum, String.
--- identifierTypeObjectContains information on customer identifier type.
---- valueStringCustomer identifier name.
---- valueTypeStringData type of the identifierType field value. For example, Boolean, Enum, String.
--- isRequiredObjectObject containing information on whether the field is mandatory.
---- valueBooleanValue indicating if the field is mandatory. Values: True - Required, False - Not required.
---- valueTypeStringData type of the isRequired field value. For example, Boolean, Enum, String.
--- sourceObjectContains information on the source of customer creation.
---- valueStringSource of customer creation.
---- valueTypeStringData type of the source field value. For example, Boolean, Enum, String.
--- isPsiDataObjectObject indicating if the field contains Protected Sensitive Information. For more information refer, Classify Potentially Sensitive Information (PSI)
---- valueBooleanValue indicating if Protected Sensitive Information is present. Values: True - PSI present, False - No PSI.
---- valueTypeStringData type of the isPsiData field value. For example, Boolean, Enum, String.
--- isUniqueKeyFieldObjectObject containing information on isUniqueKeyField attribute. Enable to make the attribute a part of a unique key. By default, the event name and customer identifier are included in the unique key. When the isuniquekeyfield attribute is enabled, it is added to the unique key with the event name and customer identifier. This ensures that the combination of these elements remains unique and consistent. Refer Enabling uniqueness check for more details.
---- valueBooleanValue indicating if the field is a unique key field. Values: True - Part of unique key, False - Not part of unique key.
---- valueTypeStringData type of the isUniqueKeyField field value. For example, Boolean, Enum, String.
--- regexObjectObject containing information for regex.
---- valueTypeStringData type of the regex field value. For example, Boolean, Enum, String.
--- possibleValuesObjectObject containing the possible values for the field.
---- valueTypeStringData type of the possibleValues field value. For example, Boolean, Enum, String.
---- valuesEnumList of possible values.
- orgIdIntegerOrganisation ID for which the events are created.
- statusStringIndicates if the event is published.
- testStatusStringIndicates if the event is verified for data flow.
- labelStringDisplay name of the event.
- descriptionStringDescription of the event.
- dateLongTimestamp for the event in UNIX epoch format.
- standardEventBooleanIndicates if the event is standard or custom. True - Standard event,
False - Custom event. For more information refer, Types of Behavioral Events
transformerMappingsObjectObject containing information on field mapping. For more information see, Transformer.
- defaultTransformerMappingObjectObject containing information on default field mapping.
- webEngageTransformerMappingObjectObject containing information on mapping for WebEngage. For more information see, WebEngage.
warningsObjectObject containing a list of warning messages, if any.
{
    "clickEventsMeta": {
        "eventId": "96d266fc6323a296701425011343c544",
        "eventName": "be_reserved",
        "eventType": "USEREVENT",
        "actions": [
            "EMFConsumer",
            "EIConsumer"
        ],
        "fields": [
            {
                "name": "customer_id",
                "type": "CUSTOMER",
                "attributes": {
                    "accountId": {
                        "valueType": "ENUM"
                    },
                    "addCustomerIfNotExists": {
                        "value": "true",
                        "valueType": "BOOLEAN"
                    },
                    "identifierType": {
                        "value": "mobile",
                        "valueType": "ENUM"
                    },
                    "isRequired": {
                        "value": "true",
                        "valueType": "BOOLEAN"
                    },
                    "source": {
                        "value": "INSTORE",
                        "valueType": "ENUM"
                    }
                }
            },
            {
                "name": "hotel_name",
                "type": "STRING",
                "attributes": {
                    "isPsiData": {
                        "value": "false",
                        "valueType": "BOOLEAN"
                    },
                    "isRequired": {
                        "value": "true",
                        "valueType": "BOOLEAN"
                    },
                    "isUniqueKeyField": {
                        "value": "true",
                        "valueType": "BOOLEAN"
                    },
                    "regex": {
                        "valueType": "STRING"
                    }
                }
            },
            {
                "name": "external_event_id",
                "type": "STRING",
                "attributes": {
                    "isPsiData": {
                        "value": "false",
                        "valueType": "BOOLEAN"
                    },
                    "isRequired": {
                        "value": "true",
                        "valueType": "BOOLEAN"
                    },
                    "isUniqueKeyField": {
                        "value": "true",
                        "valueType": "BOOLEAN"
                    },
                    "regex": {
                        "valueType": "STRING"
                    }
                }
            },
            {
                "name": "room_nights",
                "type": "ENUM",
                "attributes": {
                    "isPsiData": {
                        "value": "false",
                        "valueType": "BOOLEAN"
                    },
                    "isRequired": {
                        "value": "false",
                        "valueType": "BOOLEAN"
                    },
                    "isUniqueKeyField": {
                        "value": "false",
                        "valueType": "BOOLEAN"
                    },
                    "possibleValues": {
                        "valueType": "LIST",
                        "values": [
                            "1",
                            "2",
                            "3",
                            "4",
                            "5",
                            "6",
                            "7",
                            "8",
                            "9",
                            "10",
                            "11",
                            "12",
                            "13",
                            "14",
                            "15"
                        ]
                    }
                }
            },
            {
                "name": "age",
                "type": "DOUBLE",
                "attributes": {
                    "isPsiData": {
                        "value": "true",
                        "valueType": "BOOLEAN"
                    },
                    "isRequired": {
                        "value": "false",
                        "valueType": "BOOLEAN"
                    },
                    "isUniqueKeyField": {
                        "value": "false",
                        "valueType": "BOOLEAN"
                    }
                }
            }
        ],
        "orgId": 100458,
        "status": "PUBLISHED",
        "testStatus": "VERIFIED",
        "label": "be_reserved",
        "description": "be_reserved",
        "date": 1719227213866,
        "standardEvent": false
    },
    "transformerMappings": {
        "defaultTransformerMapping": null,
        "webEngageTransformerMapping": null
    },
    "warnings": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!