Zum Hauptinhalt springen
GET
/
events
/
v3
/
event-definitions
イベント定義を取得
curl --request GET \
  --url https://api.hubapi.com/events/v3/event-definitions \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    }
  },
  "results": [
    {
      "archived": true,
      "associations": [
        {
          "allowsCustomLabels": true,
          "cardinality": "ONE_TO_MANY",
          "category": "HUBSPOT_DEFINED",
          "fromObjectType": "ABANDONED_CART",
          "fromObjectTypeId": "<string>",
          "hasAllAssociatedObjects": true,
          "hasCascadingDeletes": true,
          "hasUserEnforcedMaxFromObjectIds": true,
          "hasUserEnforcedMaxToObjectIds": true,
          "hidden": true,
          "id": 123,
          "inverseAllowsCustomLabels": true,
          "inverseCardinality": "ONE_TO_MANY",
          "inverseHasAllAssociatedObjects": true,
          "inverseId": 123,
          "inverseLabel": "<string>",
          "inverseName": "<string>",
          "isInversePrimary": true,
          "isPrimary": true,
          "label": "<string>",
          "maxFromObjectIds": 123,
          "maxToObjectIds": 123,
          "name": "<string>",
          "portalUniqueIdentifier": "<string>",
          "toObjectType": "ABANDONED_CART",
          "toObjectTypeId": "<string>"
        }
      ],
      "comboEventRules": {
        "composingRules": [
          {
            "count": 123,
            "eventTypeId": "<string>",
            "lookbackWindowDays": 123,
            "propertyFilters": [
              {
                "filterType": "PROPERTY",
                "frameworkFilterId": 123,
                "operation": {
                  "defaultValue": "<string>",
                  "includeObjectsWithNoValueSet": true,
                  "operationType": "<string>",
                  "operator": "HAS_EVER_BEEN_EQUAL_TO",
                  "operatorName": "<string>",
                  "propertyType": "bool",
                  "value": true
                },
                "property": "<string>"
              }
            ]
          }
        ],
        "operationType": "AND",
        "ruleBranches": [
          {}
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "createdUserId": 123,
      "description": "<string>",
      "fullyQualifiedName": "<string>",
      "id": "<string>",
      "labels": {
        "plural": "<string>",
        "singular": "<string>"
      },
      "name": "<string>",
      "objectTypeId": "<string>",
      "primaryObject": "<string>",
      "primaryObjectId": "<string>",
      "properties": [
        {
          "archived": true,
          "archivedAt": "2023-11-07T05:31:56Z",
          "calculated": true,
          "calculationFormula": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdUserId": "<string>",
          "dataSensitivity": "highly_sensitive",
          "description": "<string>",
          "displayOrder": 123,
          "externalOptions": true,
          "fieldType": "<string>",
          "formField": true,
          "groupName": "<string>",
          "hasUniqueValue": true,
          "hidden": true,
          "hubspotDefined": true,
          "label": "<string>",
          "modificationMetadata": {
            "archivable": true,
            "readOnlyDefinition": true,
            "readOnlyOptions": true,
            "readOnlyValue": true
          },
          "name": "<string>",
          "options": [
            {
              "description": "<string>",
              "displayOrder": 123,
              "hidden": true,
              "label": "<string>",
              "value": "<string>"
            }
          ],
          "referencedObjectType": "<string>",
          "sensitiveDataCategories": [
            "<string>"
          ],
          "showCurrencySymbol": true,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedUserId": "<string>"
        }
      ],
      "trackingType": "CLICKED_ELEMENT"
    }
  ],
  "total": 123
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise
この API には、次のいずれかのスコープが必要です。
behavioral_events.event_definitions.read_write

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

after
string

最後に正常に読み取られたリソースのページ操作カーソルトークンは、より多くの結果を含むページ付きレスポンスのpaging.next.after JSONプロパティーとして返されます。

includeProperties
boolean
limit
integer

ページごとに表示する結果の最大数。

searchString
string

ユーザーが検索するイベント名の文字。この検索は「完全一致」検索で、あいまい一致は実行されません。

sortOrder
string

Response

successful operation

results
object[]
required
total
integer
required
paging
object