Heap

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.

Heap publishes 10 API contracts indexed on the APIs.io network, including Add Account Properties API, Add User Properties API, Identify API, and 7 more. Tagged areas include Analytics, Autocapture, Digital Analytics, Product Analytics, and Session Replay.

The Heap catalog on APIs.io includes 1 Spectral governance ruleset.

Heap’s developer surface includes documentation, getting-started guide, authentication, engineering blog, pricing, signup flow, support, and 15 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

41.7/100 developing ▬ flat Agent 27/100 agent aware Front door AI 4/6 moderate Heartbeat 50/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessFreemium

2 published contracts 16 Features

AnalyticsAutocaptureDigital Analytics Product Analytics Session Replay User Behavior

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Product Telemetry & Experimentation Management

BC-4280

Add Account PropertiesAdd User PropertiesIdentifyTrack

POST /api/track POST /api/add_account_properties POST /api/add_user_properties POST /api/v1/identify

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 41.7/100 · developing

Contract Quality 8.8 / 19

Developer Ergonomics 7.1 / 15

Access Clarity 4.9 / 15

Operational Transparency 2.6 / 10

Contract Governance 1.2 / 9

Discoverability 4.8 / 8

Regulatory Posture 2.5 / 15

Create-or-Update Ergonomics 2.8 / 10

Agent readiness — 27/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 9 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/heap/"><img src="https://apis.io/badge/heap/card.svg" alt="Heap on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Stable Error Semantics +8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
Typed Event Surface +6 pts — AsyncAPI document, OR webhooks/callbacks objects in the as-published OpenAPI, OR common[].type includes Webhooks

7 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 32.9 — up to +13.4 composite points
Contract Quality scores 47.1 — up to +13.2 composite points
Developer Ergonomics scores 47.6 — up to +10.5 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/heap/apis.yml: open an issue on github.com/api-evangelist/heap to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Martech and Customer Data Platforms	covered	52.4	-	1

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 1

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OpenAPI

measured — observed by APIs.io (published)

APIs 10

Individual APIs this provider publishes, each with its own machine-readable definition.

Heap Server-Side API

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 prope...

Heap Track API

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. Th...

Heap Identify API

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 t...

Heap Add User Properties API

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 s...

Heap Add Account Properties API

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 scenari...

Heap Add Account Properties API

The Add Account Properties API from Heap — 1 operation(s) for add account properties.

Heap Add User Properties API

The Add User Properties API from Heap — 1 operation(s) for add user properties.

Heap Identify API

The Identify API from Heap — 1 operation(s) for identify.

Heap Track API

The Track API from Heap — 1 operation(s) for track.

Heap Webhooks API

Partner-registered webhook endpoints invoked by Heap. The only documented action type is `segment.users.sync`, which delivers delta adds/removes for a Heap behavioral segment. S...

Scroll for all 10

Open Collections 7

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Heap Server-Side Add Account Properties API

OPEN COLLECTION

Heap Server-Side Add Account Properties Add User Properties API

OPEN COLLECTION

Heap Server-Side Add Account Properties Identify API

OPEN COLLECTION

Heap Server-Side Add Account Properties Track API

OPEN COLLECTION

Heap Server-Side Add Account Properties Webhooks API

OPEN COLLECTION

Heap Partner Webhooks (Data-out API)

OPEN COLLECTION

Heap Server-Side API

OPEN COLLECTION

Scroll for all 7

Heap API pricing

Not yet checked against Heap's own pricing page. Compiled by API Evangelist on 2026-05-04 from heap.io/pricing; confirm before you rely on a figure. A free plan or tier is listed.

Plan	Price
Free freemium	Free
Growth enterprise	—
Pro enterprise	—
Premier enterprise	—

Plan details, limits and sources →

Rate limits

Track API: high (auto-scales) events per second
REST API: 60 requests per minute
Bulk identify: 1000 users

Compiled by API Evangelist, not yet checked against Heap's documentation. Rate-limit details →

Pricing Plans 1

Published pricing tiers and plan structures.

Heap Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Heap Rate Limits

3 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

Heap

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Heap Finops

FINOPS

Features 16

Notable capabilities this provider offers.

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

Scroll for all 16

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Heap API Rules

48 rules · 46 errors 1 warnings 1 info

SPECTRAL

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Heap Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Heap Trust Center

SOC 2, ISO 27001, ISO 27017, ISO 27018

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Heap Agentic Access

5 operations · 5 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

GettingStarted

GettingStarted

Login

Signup

Signup

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

LlmsText

LlmsText

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

Access & Security 3

Authentication, authorization, and security posture

TrustCenter

TrustCenter

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 3

Status, limits, changes, and where to get help

RateLimits

RateLimits

Support

Support

StatusPage

StatusPage

Commercial 5

Pricing, plans, and the legal terms of use

Plans

FinOps

Pricing

TermsOfService

PrivacyPolicy

Company 3

The organization behind the API

LinkedIn

Website

Website

Blog

Blog

Other 1

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Source (apis.yml)

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: low
  source:
  - plans
  - security
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/heap.png
x-docs-platform: readme
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-03
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: Plans
  url: plans/heap-plans-pricing.yml
- type: RateLimits
  url: rate-limits/heap-rate-limits.yml
- type: FinOps
  url: finops/heap-finops.yml
- type: CapabilityMap
  url: capabilities/heap-capability-edges.yml
  name: Heap Business Capability Map
- 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

Heap API — frequently asked questions

Does Heap have an API?

Yes. APIs.io lists 10 APIs from Heap, including Heap Server-Side API, Heap Track API and Heap Identify API, and 7 more.

Is there an OpenAPI specification for the Heap API?

Yes. APIs.io indexes 5 OpenAPI specifications for Heap, each linked for download from this page.

How do I authenticate with the Heap API?

Heap uses bearer-token authentication.

How much does the Heap API cost?

APIs.io lists 4 pricing plans for Heap, with each plan's price, limits and inclusions under Pricing on this page.

Is the Heap API ready for AI agents?

Heap has a Kin Score of 41.7 out of 100 (developing) and an Agent Readiness score of 26.9 (agent-aware), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/heap"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/heap/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/heap/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.