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

Amplitude Annotations API

Chart annotation management operations

Amplitude Annotations API is one of 33 APIs that Amplitude 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 and API documentation.

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

Requests are made against 2 base URLs: https://api2.amplitude.com, https://api.eu.amplitude.com.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://api2.amplitude.com
Terms of Service
Resource Areas
1

Paths & Operations 5

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

Annotations 5

Chart annotation management operations

GET
/api/3/annotations
Amplitude List All Annotations
listAnnotations → 200401
POST
/api/3/annotations
Amplitude Create an Annotation
createAnnotation body → 200400401
GET
/api/3/annotations/{annotation_id}
Amplitude Get an Annotation
getAnnotation 1 param → 200401404
PUT
/api/3/annotations/{annotation_id}
Amplitude Update an Annotation
updateAnnotation 1 param body → 200400401404
DELETE
/api/3/annotations/{annotation_id}
Amplitude Delete an Annotation
deleteAnnotation 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Annotation (9 properties), CreateAnnotationRequest (6 properties), UpdateAnnotationRequest (6 properties), AnnotationListResponse (1 property). Each schema is shown below with its type and property counts.

UpdateAnnotationRequest
object
6 properties
CreateAnnotationRequest
object
6 properties 2 required
Annotation
object
9 properties
AnnotationListResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amplitude-annotations-api-openapi.yml Raw ↑

Other APIs Amplitude publishes across the network.

Amplitude Batch Event Upload API
Amplitude Identify API
Amplitude Group Identify API
Amplitude Export API
Amplitude Attribution API
Amplitude Releases API
Amplitude Session Replay API
Amplitude User Mapping API
Amplitude User Privacy API
Amplitude Webhooks and Cohort Sync
Amplitude Cohorts API
Amplitude Data Access API