Zum Hauptinhalt springen
GET
/
events
/
v3
/
events
/
Event-Instanz-Abfrage
curl --request GET \
  --url https://api.hubapi.com/events/v3/events/ \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "occurredAt": "2023-11-07T05:31:56Z",
      "eventType": "<string>",
      "id": "<string>",
      "objectId": "<string>",
      "properties": {},
      "objectType": "<string>"
    }
  ]
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

​
Erforderliche Bereiche

Diese API erfordert einen der folgenden Bereiche:
  • oauth

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
objectType
string

Der Name des CRM-Objekttyps, nach dem Event-Instanzen gefiltert werden sollen. Optional können Sie auch eine objectId in einem anderen Parameter angeben, um nach einer bestimmten CRM-Objekt-Instanz zu filtern.

​
eventType
string

Der Event-Typname. Eine Liste der verfügbaren Event-Typnamen kann über einen anderen API-Aufruf abgerufen werden.

​
after
string

Das Paginierungscursor-Token der zuletzt erfolgreich gelesenen Ressource wird als „paging.next.after“-JSON-Eigenschaft einer paginierten Antwort mit weiteren Ergebnissen zurückgegeben.

​
before
string

Pagination cursor for backward navigation. Retrieves events occurring before the specified cursor position. Note: Currently only forward pagination with after is supported.

​
limit
integer

Die maximale Anzahl der Ergebnisse, die pro Seite angezeigt werden.

​
sort
string[]

Sortierrichtung basierend auf dem Zeitstempel der Event-Instanz, ASCENDING oder DESCENDING.

​
occurredAfter
string<date-time>

Filter for event data that occurred after a specific datetime.

​
occurredBefore
string<date-time>

Filter for event data that occurred before a specific datetime.

​
objectId
integer

Die ID des CRM-Objekts, nach dem Event-Instanzen gefiltert werden sollen. Wenn Sie nach objectId filtern, müssen Sie auch einen objectType angeben.

​
objectProperty.{propname}
object

Instead of retrieving event data for a specific object by its ID, you can specify a unique identifier property. For contacts, you can use the email property. (e.g., objectProperty.email=name@domain.com).

​
property.{propname}
object

Filter for event completions that contain a specific value for an event property (e.g., property.hs_city=portland). For properties values with spaces, replaces spaces with %20 or + (e.g., property.hs_city=new+york).

​
id
string[]

ID einer Event-Instanz. IDs sind für Event-Instanzen eindeutig (1-zu-1-Zuordnung). Wenn Sie diesen Filter und zusätzliche Filter angeben, müssen die anderen Filter mit den Werten der Event-Instanz übereinstimmen, um Treffer zu erzielen.

Response

successful operation

​
results
object[]
required
​
paging
object
⌘I