OptionalrequestFactory: EventsApiRequestFactoryOptionalresponseProcessor: EventsApiResponseProcessorOptionalobjectType: stringThe type of CRM object to filter event instances on (e.g., `contact`). To retrieve event data for a specific CRM record, include the additional `objectId` query parameter (below).
OptionaleventType: stringThe event type name. You can retrieve available event types using the event types endpoint.
Optionalafter: stringThe paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
Optionalbefore: stringOptionallimit: numberThe maximum number of results to display per page.
Optionalsort: string[]Sort direction based on the timestamp of the event instance, `ASCENDING` or `DESCENDING`.
OptionaloccurredAfter: DateFilter for event data that occurred after a specific datetime.
OptionaloccurredBefore: DateFilter for event data that occurred before a specific datetime.
OptionalobjectId: numberThe ID of the CRM Object to filter event instances on. When including this parameter, you must also include the `objectType` parameter.
OptionalobjectPropertyPropname: anyInstead 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`).
OptionalpropertyPropname: anyFilter 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`).
Optionalid: string[]ID of an event instance. IDs are 1:1 with event instances. If you provide this filter and additional filters, the other filters must match the values on the event instance to yield results.
Optional_options: PromiseConfigurationOptionsRetrieve instances of event completion data. For example, retrieve all event completions associated with a specific contact. Retrieve event data
OptionalobjectType: stringThe type of CRM object to filter event instances on (e.g., `contact`). To retrieve event data for a specific CRM record, include the additional `objectId` query parameter (below).
OptionaleventType: stringThe event type name. You can retrieve available event types using the event types endpoint.
Optionalafter: stringThe paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
Optionalbefore: stringOptionallimit: numberThe maximum number of results to display per page.
Optionalsort: string[]Sort direction based on the timestamp of the event instance, `ASCENDING` or `DESCENDING`.
OptionaloccurredAfter: DateFilter for event data that occurred after a specific datetime.
OptionaloccurredBefore: DateFilter for event data that occurred before a specific datetime.
OptionalobjectId: numberThe ID of the CRM Object to filter event instances on. When including this parameter, you must also include the `objectType` parameter.
OptionalobjectPropertyPropname: anyInstead 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`).
OptionalpropertyPropname: anyFilter 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`).
Optionalid: string[]ID of an event instance. IDs are 1:1 with event instances. If you provide this filter and additional filters, the other filters must match the values on the event instance to yield results.
Optional_options: PromiseConfigurationOptionsThis endpoint returns a list of event type names which are visible to you. You may use these event type names to query the API for specific event instances of a desired type. Note: the get_types method is only supported in the Python SDK version 12.0.0-beta.1 or later.
Event Types
Optional_options: PromiseConfigurationOptionsThis endpoint returns a list of event type names which are visible to you. You may use these event type names to query the API for specific event instances of a desired type. Note: the get_types method is only supported in the Python SDK version 12.0.0-beta.1 or later.
Event Types
Optional_options: PromiseConfigurationOptions
Retrieve instances of event completion data. For example, retrieve all event completions associated with a specific contact. Retrieve event data