HubSpot · JSON Structure

Analytics Events Api Event Instance Collection Structure

Paginated collection of event instances

Type: object Properties: 2 Required: 1
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

EventInstanceCollection is a JSON Structure definition published by HubSpot, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

results paging

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/analytics-events-api-event-instance-collection-structure.json",
  "name": "EventInstanceCollection",
  "description": "Paginated collection of event instances",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Represents a single event instance that occurred in the system",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the event instance",
            "example": "500123"
          },
          "eventType": {
            "type": "string",
            "description": "The type of event that occurred",
            "example": "standard"
          },
          "objectId": {
            "type": "string",
            "description": "The ID of the CRM object associated with this event",
            "example": "500123"
          },
          "objectType": {
            "type": "string",
            "description": "The type of CRM object (e.g., contact, company, deal)",
            "example": "standard"
          },
          "occurredAt": {
            "type": "datetime",
            "description": "ISO 8601 timestamp when the event occurred",
            "example": "2025-03-15T14:30:00Z"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Additional properties associated with the event",
            "example": {
              "key": "value"
            }
          }
        },
        "required": [
          "id",
          "eventType",
          "occurredAt"
        ]
      },
      "description": "Array of event instances",
      "example": [
        {
          "id": "500123",
          "eventType": "standard",
          "objectId": "500123",
          "objectType": "standard",
          "occurredAt": "2025-03-15T14:30:00Z",
          "properties": {
            "key": "value"
          }
        }
      ]
    },
    "paging": {
      "type": "object",
      "description": "Pagination information for navigating result sets",
      "properties": {
        "next": {
          "type": "object",
          "description": "Pagination cursor for retrieving the next page of results",
          "properties": {
            "after": {
              "type": "string",
              "description": "Cursor token for the next page",
              "example": "example-value"
            },
            "link": {
              "type": "string",
              "description": "API link to the next page of results",
              "example": "https://app.hubspot.com/contacts/12345"
            }
          }
        },
        "prev": {
          "type": "object",
          "description": "Pagination cursor for retrieving the previous page of results",
          "properties": {
            "before": {
              "type": "string",
              "description": "Cursor token for the previous page",
              "example": "example-value"
            },
            "link": {
              "type": "string",
              "description": "API link to the previous page of results",
              "example": "https://app.hubspot.com/contacts/12345"
            }
          }
        }
      }
    }
  },
  "required": [
    "results"
  ]
}