curl --request GET \
--url https://api.hubapi.com/events/v3/event-definitions \
--header 'Authorization: Bearer <token>'
{
"total": 123,
"paging": {
"next": {
"link": "",
"after": ""
}
},
"results": [
{
"associations": [
{
"inverseLabel": "",
"hidden": false,
"allowsCustomLabels": false,
"maxFromObjectIds": 123,
"inverseAllowsCustomLabels": false,
"isPrimary": false,
"hasUserEnforcedMaxToObjectIds": false,
"hasUserEnforcedMaxFromObjectIds": false,
"id": 123,
"toObjectTypeId": "",
"inverseCardinality": "",
"maxToObjectIds": 123,
"hasCascadingDeletes": false,
"fromObjectType": "",
"toObjectType": "",
"label": "",
"inverseId": 123,
"cardinality": "",
"inverseName": "",
"hasAllAssociatedObjects": false,
"inverseHasAllAssociatedObjects": false,
"fromObjectTypeId": "",
"portalUniqueIdentifier": "",
"isInversePrimary": false,
"name": "",
"category": ""
}
],
"objectTypeId": "<string>",
"createdUserId": 123,
"trackingType": "VISITED_URL",
"description": "<string>",
"primaryObjectId": "<string>",
"comboEventRules": {
"operationType": "AND",
"composingRules": [
{
"lookbackWindowDays": 123,
"eventTypeId": "<string>",
"propertyFilters": [
{
"frameworkFilterId": 123,
"property": "<string>",
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"defaultValue": "<string>",
"propertyType": "bool",
"operationType": "<string>",
"value": true,
"operatorName": "<string>",
"operator": "IS_EQUAL_TO"
}
}
],
"count": 123
}
],
"ruleBranches": [
{}
]
},
"fullyQualifiedName": "<string>",
"primaryObject": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"id": "<string>",
"properties": [
{
"hidden": false,
"displayOrder": 123,
"description": "",
"showCurrencySymbol": false,
"type": "",
"hubspotDefined": false,
"createdAt": "2023-11-07T05:31:56Z",
"archived": false,
"options": "",
"hasUniqueValue": false,
"calculated": false,
"externalOptions": false,
"updatedAt": "2023-11-07T05:31:56Z",
"createdUserId": "",
"modificationMetadata": {
"readOnlyOptions": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"archivable": true
},
"sensitiveDataCategories": "",
"label": "",
"formField": false,
"dataSensitivity": "",
"archivedAt": "2023-11-07T05:31:56Z",
"groupName": "",
"referencedObjectType": "",
"name": "",
"calculationFormula": "",
"fieldType": "",
"updatedUserId": "<string>"
}
]
}
]
}
既存のカスタムイベント定義を取得します。
curl --request GET \
--url https://api.hubapi.com/events/v3/event-definitions \
--header 'Authorization: Bearer <token>'
{
"total": 123,
"paging": {
"next": {
"link": "",
"after": ""
}
},
"results": [
{
"associations": [
{
"inverseLabel": "",
"hidden": false,
"allowsCustomLabels": false,
"maxFromObjectIds": 123,
"inverseAllowsCustomLabels": false,
"isPrimary": false,
"hasUserEnforcedMaxToObjectIds": false,
"hasUserEnforcedMaxFromObjectIds": false,
"id": 123,
"toObjectTypeId": "",
"inverseCardinality": "",
"maxToObjectIds": 123,
"hasCascadingDeletes": false,
"fromObjectType": "",
"toObjectType": "",
"label": "",
"inverseId": 123,
"cardinality": "",
"inverseName": "",
"hasAllAssociatedObjects": false,
"inverseHasAllAssociatedObjects": false,
"fromObjectTypeId": "",
"portalUniqueIdentifier": "",
"isInversePrimary": false,
"name": "",
"category": ""
}
],
"objectTypeId": "<string>",
"createdUserId": 123,
"trackingType": "VISITED_URL",
"description": "<string>",
"primaryObjectId": "<string>",
"comboEventRules": {
"operationType": "AND",
"composingRules": [
{
"lookbackWindowDays": 123,
"eventTypeId": "<string>",
"propertyFilters": [
{
"frameworkFilterId": 123,
"property": "<string>",
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"defaultValue": "<string>",
"propertyType": "bool",
"operationType": "<string>",
"value": true,
"operatorName": "<string>",
"operator": "IS_EQUAL_TO"
}
}
],
"count": 123
}
],
"ruleBranches": [
{}
]
},
"fullyQualifiedName": "<string>",
"primaryObject": "<string>",
"labels": {
"plural": "<string>",
"singular": "<string>"
},
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"id": "<string>",
"properties": [
{
"hidden": false,
"displayOrder": 123,
"description": "",
"showCurrencySymbol": false,
"type": "",
"hubspotDefined": false,
"createdAt": "2023-11-07T05:31:56Z",
"archived": false,
"options": "",
"hasUniqueValue": false,
"calculated": false,
"externalOptions": false,
"updatedAt": "2023-11-07T05:31:56Z",
"createdUserId": "",
"modificationMetadata": {
"readOnlyOptions": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"archivable": true
},
"sensitiveDataCategories": "",
"label": "",
"formField": false,
"dataSensitivity": "",
"archivedAt": "2023-11-07T05:31:56Z",
"groupName": "",
"referencedObjectType": "",
"name": "",
"calculationFormula": "",
"fieldType": "",
"updatedUserId": "<string>"
}
]
}
]
}
behavioral_events.event_definitions.read_write
The access token received from the authorization server in the OAuth 2.0 flow.
ユーザーが検索するイベント名の文字。この検索は「完全一致」検索で、あいまい一致は実行されません。
前回正常に読み取られたリソースのページ設定カーソルトークンが、その他の結果が含まれるページ設定されたレスポンスの「paging.next.after」JSONプロパティーとして返されます。
ページごとに表示する結果の最大数。
successful operation
The response is of type object
.