Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adobe Analytics Annotations API

Manage analytics annotations

Adobe Analytics Annotations API is one of 14 APIs that Adobe Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Annotations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and rate-limit docs.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://analytics.adobe.io/api/{globalCompanyId}.

3 operations 2 paths 3 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Server
https://analytics.adobe.io/api/{globalCompanyId}
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Adobe Analytics Annotations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as x-api-key (apiKey). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token from Adobe IMS
  • apiKey — Adobe Developer Console API key

Paths & Operations 3

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

Annotations 3

Manage analytics annotations

GET
/annotations
Adobe Analytics List Annotations
listAnnotations 2 params → 200
POST
/annotations
Adobe Analytics Create an Annotation
createAnnotation body → 200
GET
/componentmetadata/tags
Adobe Analytics List Tags
listTags → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Annotation (6 properties), AnnotationCreate (5 properties), Tag (4 properties). Each schema is shown below with its type and property counts.

Annotation
object
An annotation marking a date range in reports
6 properties
AnnotationCreate
object
Payload for creating an annotation
5 properties 2 required
Tag
object
A tag applied to an Analytics component
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adobe-analytics-annotations-api-openapi.yml Raw ↑

Other APIs Adobe Analytics publishes across the network.

Adobe Analytics Livestream API
Adobe Analytics Data Insertion API
Adobe Analytics 1.4 API
Adobe Analytics Calculated Metrics API
Adobe Analytics Date Ranges API
Adobe Analytics Dimensions API
Adobe Analytics Events API
Adobe Analytics Jobs API
Adobe Analytics Metrics API
Adobe Analytics Report Suites API
Adobe Analytics Reports API
Adobe Analytics Segments API