Heap

aid: heap
name: Heap
description: Heap is a digital analytics platform that automatically captures every user interaction on web and mobile applications
  without requiring manual event tracking code. It provides product analytics, session replay, and behavioral data science
  capabilities to help teams understand user behavior and improve digital experiences.
type: Index
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Freemium
  confidence: medium
  source:
  - plans
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/heap.png
tags:
- Analytics
- Autocapture
- Digital Analytics
- Product Analytics
- Session Replay
- User Behavior
url: https://raw.githubusercontent.com/api-evangelist/heap/refs/heads/main/apis.yml
created: '2026-03-26'
modified: '2026-05-30'
specificationVersion: '0.23'
apis:
- aid: heap:server-side-api
  name: Heap Server-Side API
  description: The Heap Server-Side API allows developers to send track, identify, and add user properties events to Heap
    from backend servers. It supports sending custom events and user properties that cannot be captured through Heap's automatic
    client-side tracking, such as server-side transactions, subscription changes, and backend process completions.
  humanURL: https://developers.heap.io/reference/server-side-apis-overview
  tags:
  - Analytics
  - Event
  - Server-Side
  - Tracking
  tags_raw:
  - Analytics
  - Events
  - Server-Side
  - Tracking
  properties:
  - type: Documentation
    url: https://developers.heap.io/reference/server-side-apis-overview
  - type: GettingStarted
    url: https://developers.heap.io/docs/getting-started
- aid: heap:track-api
  name: Heap Track API
  description: The Heap Track API enables developers to send custom track events from server-side applications to Heap. Each
    event includes an identity, event name, and optional properties. This API is used to capture important backend events
    such as purchases, subscription upgrades, or other server-side actions that supplement Heap's automatic client-side tracking.
  humanURL: https://developers.heap.io/reference/track-1
  tags:
  - Analytics
  - Event
  - Tracking
  tags_raw:
  - Analytics
  - Events
  - Tracking
  properties:
  - type: Documentation
    url: https://developers.heap.io/reference/track-1
- aid: heap:identify-api
  name: Heap Identify API
  description: The Heap Identify API allows developers to associate a user identity with Heap's automatically captured data
    from the server side. This enables linking anonymous user sessions to known user identities when authentication or identification
    occurs on the backend rather than the client side.
  humanURL: https://developers.heap.io/reference/identify-1
  tags:
  - Analytics
  - Identity
  - User
  tags_raw:
  - Analytics
  - Identity
  - Users
  properties:
  - type: Documentation
    url: https://developers.heap.io/reference/identify-1
- aid: heap:add-user-properties-api
  name: Heap Add User Properties API
  description: The Heap Add User Properties API enables developers to attach custom properties to user profiles from server-side
    applications. These properties can include attributes such as subscription tier, account type, company name, or any other
    user-level data that enriches Heap's behavioral analytics and segmentation capabilities.
  humanURL: https://developers.heap.io/reference/add-user-properties-1
  tags:
  - Analytics
  - Properties
  - User
  tags_raw:
  - Analytics
  - Properties
  - Users
  properties:
  - type: Documentation
    url: https://developers.heap.io/reference/add-user-properties-1
- aid: heap:add-account-properties-api
  name: Heap Add Account Properties API
  description: The Heap Add Account Properties API allows developers to attach custom properties to account-level profiles
    from server-side applications. This is used for B2B analytics scenarios where users belong to organizations or accounts,
    enabling analysis at the account level in addition to the individual user level.
  humanURL: https://developers.heap.io/reference/add-account-properties-1
  tags:
  - Account
  - Analytics
  - B2B
  - Properties
  tags_raw:
  - Accounts
  - Analytics
  - B2B
  - Properties
  properties:
  - type: Documentation
    url: https://developers.heap.io/reference/add-account-properties-1
- aid: heap:heap-add-account-properties-api
  name: Heap Add Account Properties API
  description: The Add Account Properties API from Heap — 1 operation(s) for add account properties.
  humanURL: https://developers.heap.io/reference/server-side-apis-overview
  tags:
  - Add Account Properties
  properties:
  - type: OpenAPI
    url: openapi/heap-add-account-properties-api-openapi.yml
  - type: Documentation
    url: https://developers.heap.io/docs/creating-a-new-heap-integration-partners
  - type: Reference
    url: https://github.com/heap/heap-partner-api-reference
- aid: heap:heap-add-user-properties-api
  name: Heap Add User Properties API
  description: The Add User Properties API from Heap — 1 operation(s) for add user properties.
  humanURL: https://developers.heap.io/reference/server-side-apis-overview
  tags:
  - Add User Properties
  properties:
  - type: OpenAPI
    url: openapi/heap-add-user-properties-api-openapi.yml
  - type: Documentation
    url: https://developers.heap.io/docs/creating-a-new-heap-integration-partners
  - type: Reference
    url: https://github.com/heap/heap-partner-api-reference
- aid: heap:heap-identify-api
  name: Heap Identify API
  description: The Identify API from Heap — 1 operation(s) for identify.
  humanURL: https://developers.heap.io/reference/server-side-apis-overview
  tags:
  - Identify
  properties:
  - type: OpenAPI
    url: openapi/heap-identify-api-openapi.yml
  - type: Documentation
    url: https://developers.heap.io/docs/creating-a-new-heap-integration-partners
  - type: Reference
    url: https://github.com/heap/heap-partner-api-reference
- aid: heap:heap-track-api
  name: Heap Track API
  description: The Track API from Heap — 1 operation(s) for track.
  humanURL: https://developers.heap.io/reference/server-side-apis-overview
  tags:
  - Track
  properties:
  - type: OpenAPI
    url: openapi/heap-track-api-openapi.yml
  - type: Documentation
    url: https://developers.heap.io/docs/creating-a-new-heap-integration-partners
  - type: Reference
    url: https://github.com/heap/heap-partner-api-reference
- aid: heap:heap-webhooks-api
  name: Heap Webhooks API
  description: "Partner-registered webhook endpoints invoked by Heap. The only\ndocumented action type is `segment.users.sync`,\
    \ which delivers\ndelta adds/removes for a Heap behavioral segment.\n\nSignature verification:\n  1. Parse the `Heap-Hash`\
    \ header (comma-separated key:value pairs).\n  2. Confirm the `ts` value is within the partner's tolerance window.\n \
    \ 3. Concatenate `${ts}${requestbody}`.\n  4. Compute HMAC-SHA256 using the `webhook_secret_key` assigned at\n     webhook\
    \ creation.\n  5. Constant-time compare against the `hmac` value from the header.\n\nReturn `200 OK` on success; `429`\
    \ or other non-2xx responses trigger\nretries by Heap."
  humanURL: https://developers.heap.io/reference/server-side-apis-overview
  tags:
  - Webhook
  tags_raw:
  - Webhooks
  properties:
  - type: OpenAPI
    url: openapi/heap-webhooks-api-openapi.yml
  - type: Documentation
    url: https://developers.heap.io/docs/creating-a-new-heap-integration-partners
  - type: Reference
    url: https://github.com/heap/heap-partner-api-reference
common:
- type: AgenticAccess
  url: agentic-access/heap-agentic-access.yml
- type: TrustCenter
  url: security/heap-trust-center.yml
- type: DomainSecurity
  url: security/heap-domain-security.yml
- type: GitHubOrganization
  url: https://github.com/heap
- type: LinkedIn
  url: https://www.linkedin.com/company/heap-inc-
- type: Website
  url: https://www.heap.io
- type: Documentation
  url: https://developers.heap.io
- type: GettingStarted
  url: https://developers.heap.io/docs/getting-started
- type: Authentication
  url: https://developers.heap.io/reference/authentication
- type: Blog
  url: https://www.heap.io/blog
- type: Pricing
  url: https://www.heap.io/pricing
- type: Login
  url: https://heapanalytics.com/app/login
- type: Signup
  url: https://heapanalytics.com/signup
- type: Support
  url: https://help.heap.io
- type: TermsOfService
  url: https://www.heap.io/terms-of-service
- type: PrivacyPolicy
  url: https://www.heap.io/privacy-policy
- type: StatusPage
  url: https://status.heap.io
- type: Features
  data:
  - 'Free: 10K monthly sessions, 6 months history, SSO'
  - 'Growth: custom sessions, Sense AI Assistant, 12 months history'
  - 'Pro: account analytics, engagement matrix, session replay add-on'
  - 'Premier: data warehouse integration, region-specific storage, dedicated CSM'
  - Auto-capture for click/page-view tracking
  - Define events retroactively
  - Funnels, retention, paths analysis
  - Account-based analytics (Pro+)
  - Behavioral cohorts
  - REST API at heapanalytics.com/api
  - 'Track API: high-throughput (auto-scales)'
  - 'REST: 60 req/min/project'
  - 'Bulk identify: 1,000 users/request'
  - Webhooks for cohorts and segments
  - Acquired by Contentsquare (2023)
  - OAuth + API tokens
  sources:
  - https://heap.io/pricing
  updated: '2026-05-04'
- type: Integrations
  url: https://www.heap.io/partners
- type: LlmsText
  url: https://developers.heap.io/llms.txt
integrations:
- name: heap partners
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com