There's a new version of the HubSpot API

Starting November 30, 2022, API keys will be sunset as an authentication method. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get a Group of Events by ID

Last updated June 17, 2020

GET /reports/v2/events/batch

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

business-intelligence

Given a batch of event IDs, returns a list of event definitions in a given portal. Events can be created in-app, or dynamically via the Tracking Code API

Note: Access to the data from this endpoint will require a Marketing Hub Enterprise subscription. Please see the overview page for more details.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
ID &id= The ID of an event. Can be included multiple times to pull multiple events.

Optional Parameters How to use Description
Include deleted includeDeletes=true If specified as true, will include deleted events.