Zum Hauptinhalt springen
GET
/
events
/
v3
/
events
/
Demande d'instance d'événement
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>"
    }
  ]
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Entreprise
Sales HubSales Hub -Entreprise
Service HubService Hub -Entreprise
Content HubContent Hub -Entreprise
Cette API requiert l'une des portées suivantes :
oauth

Authorizations

Authorization
string
header
required

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

Query Parameters

objectType
string

Le nom du type d'objet CRM à partir duquel filtrer les instances d'objets. Vous pouvez également si vous le souhaitez fournir un objectId dans un autre paramètre pour filtrer à partir d'une instance d'objet CRM spécifique.

eventType
string

Le nom du type d'événement. La liste des noms de types d'événements disponibles peut être obtenue à partir d'un autre appel d'API.

after
string

Le jeton de curseur de pagination de la dernière ressource lue avec succès sera renvoyé en tant que propriété JSON « paging.next.after » d'une réponse paginée contenant plus de résultats.

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

Le nombre maximum de résultats à afficher par page.

sort
string[]

Triez la direction en fonction de l'horodatage de l'instance d'événement, CROISSANT ou DÉCROISSANT.

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

L'ID du filtre d'objet CRM sur lequel filtrer des instances d'événement. Si vous filtrez à partir d'un objectId, vous devez également fournir un objectType.

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 d'une instance d'événement. Les ID sont individuels pour les instances d'événements. Si vous fournissez ce filtre et des filtres supplémentaires, les autres filtres doivent correspondre aux valeurs figurant sur l'instance d'événement pour donner des résultats.

Response

successful operation

results
object[]
required
paging
object
I