How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Convert Experiences Heatmaps API

Endpoints to retrieve heatmap background and overlay images (Convert Signals™). Filters such as device and interaction type are passed in the request body.

Convert Experiences Heatmaps API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Experiences Heatmaps. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against 3 base URLs: https://api.convert.com/api/v2, https://apidev.convert.com/api/v2, http://apidev.convert.com:5000/api/v2.

2 operations 2 paths 7 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.convert.com/api/v2
Authentication
API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 3

Convert Experiences Heatmaps API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (requestSigning). It accepts HTTP bearer tokens (secretKey). An API key is passed in the cookie as sid (cookieAuthentication).

  • requestSigning — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
  • secretKey — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
  • cookieAuthentication — Cookie authentication is used against Convert's own IdentityProvider or third party identity providers and is described more in the "[Cookie Authentication](ta…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Experiences Heatmaps 2

Endpoints to retrieve heatmap background and overlay images (Convert Signals™). Filters such as device and interaction type are passed in the request body.

POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/heatmaps/{heatmap_id}/background
Get heatmap background image
getExperienceHeatmapBackground 4 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/heatmaps/{heatmap_id}/overlay
Get heatmap overlay (interaction) image
getExperienceHeatmapOverlay 4 params body → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ErrorData (3 properties), GetExperienceHeatmapOverlayRequestData (2 properties), ExperienceHeatmapOverlayResponseData (1 property), GetExperienceHeatmapBackgroundRequestData (1 property). Each schema is shown below with its type and property counts.

ExperienceHeatmapBackgroundResponseData
object
Response for POST heatmap background by heatmap id.
1 property
GetExperienceHeatmapOverlayRequestData
object
Optional filters for the heatmap overlay (interaction) image.
2 properties
HeatmapDevices
string
Device type for the heatmap image.
GetExperienceHeatmapBackgroundRequestData
object
Optional filters for the heatmap background image.
1 property
ExperienceHeatmapOverlayResponseData
object
Response for POST heatmap overlay by heatmap id.
1 property
HeatmapInteractions
string
Interaction type for the heatmap overlay.
ErrorData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convert-experiences-heatmaps-api-openapi.yml Raw ↑

Other APIs Convert publishes across the network.

Convert Experiences REST API v2
Convert Accounts API
Convert AI content API
Convert API Keys API
Convert Audiences API
Convert Bulk API
Convert Cdn Images API
Convert Collaborators API
Convert Cookie Authentication API
Convert Domains API
Convert Experience Sections API
Convert Experience Variations API
Where this information came from

This is an independent, third-party profile of Convert Experiences Heatmaps API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.