Adobe Suite

Adobe Suite Annotations API

The Annotations API from Adobe Suite — 2 operation(s) for annotations.

GitHub OpenAPI
Business capability
Analytics & BI Management BC-610.50

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /{globalCompanyId}/annotations List Analytics annotations · Retrieve all annotations #
Ask an LLM
“How do I list all the annotations in my Adobe Analytics company?”
“Can I filter annotations to those modified after a certain date?”
Tell an agent
List annotations for company {globalCompanyId}.
List annotations in company {globalCompanyId} within {filterByDateRange}.
POST /{globalCompanyId}/annotations Create an Analytics annotation · Create new annotation #
Ask an LLM
“How do I add an annotation to mark an event on my reports?”
“Can I create an annotation that applies to all reports?”
Tell an agent
Create annotation {name} for {dateRange} in company {globalCompanyId}.
Add a {color} annotation {name} described as {description} in {globalCompanyId}.
GET /{globalCompanyId}/annotations/{id} Get one Analytics annotation · Get existing annotation #
Ask an LLM
“What are the details of a specific annotation?”
“Can I expand extra fields like tags when fetching one annotation?”
Tell an agent
Show me annotation {id} in company {globalCompanyId}.
Get annotation {id} from {globalCompanyId} expanded with {expansion}.
PUT /{globalCompanyId}/annotations/{id} Update an existing Analytics annotation · Update existing annotation #
Ask an LLM
“How do I change the name or dates on an annotation I already made?”
“Can I edit an existing annotation's color or description?”
Tell an agent
Update annotation {id} in company {globalCompanyId}.
Rename annotation {id} in {globalCompanyId} to {name}.
DELETE /{globalCompanyId}/annotations/{id} Delete an Analytics annotation · Delete existing annotation #
Ask an LLM
“How do I delete an annotation that is no longer relevant?”
“Is removing an annotation permanent?”
Tell an agent destructive · confirm first
Delete annotation {id} in company {globalCompanyId}.
Remove annotation {id} from {globalCompanyId}.

Documentation

📖
Documentation
https://developer.adobe.com/photoshop/api/docs/
📖
Authentication
https://developer.adobe.com/developer-console/docs/guides/authentication/
📖
Documentation
https://developer.adobe.com/lightroom/api/docs/
📖
Documentation
https://developer.adobe.com/illustrator/api/docs/
📖
Documentation
https://developer.adobe.com/indesign/docs/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/
📖
GettingStarted
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/
📖
Documentation
https://developer.adobe.com/analytics-apis/docs/
📖
APIReference
https://developer.adobe.com/analytics-apis/docs/2.0/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/
📖
APIReference
https://developer.adobe.com/firefly-services/docs/api/
📖
Documentation
https://developer.adobe.com/audio-video-firefly-services/
📖
GettingStarted
https://developer.adobe.com/audio-video-firefly-services/getting-started/
📖
Documentation
https://developer.adobe.com/creative-cloud-libraries/docs/
📖
APIReference
https://developer.adobe.com/creative-cloud-libraries/docs/api/
📖
Documentation
https://developer.adobe.com/express/embed-sdk/docs/guides/
📖
APIReference
https://developer.adobe.com/express/embed-sdk/docs/v4/
📖
GettingStarted
https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/
📖
Documentation
https://developer.adobe.com/experience-platform-apis/
📖
GettingStarted
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide
📖
Documentation
https://developer.adobe.com/marketo-apis/
📖
Authentication
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication
📖
Documentation
https://developer.adobe.com/commerce/docs/
📖
GettingStarted
https://developer.adobe.com/commerce/webapi/get-started/
📖
Documentation
https://developer.adobe.com/experience-cloud/cloud-manager/
📖
Documentation
https://developer.adobe.com/journey-optimizer-apis/
📖
Documentation
https://developer.adobe.com/workfront-apis/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/substance3d/
📖
Documentation
https://developer.adobe.com/data-collection-apis/
📖
Documentation
https://developer.adobe.com/adobe-status/
📖
Documentation
https://developer.adobe.com/vip-marketplace/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/adobe-suite/openapi/adobe-suite-annotations-api-openapi.yml

Other Resources

🔗
Pricing
https://developer.adobe.com/document-services/pricing/
🔗
SDKs
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/
🔗
ReleaseNotes
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes
🔗
Guides
https://developer.adobe.com/analytics-apis/docs/2.0/guides/
🔗
Guides
https://developer.adobe.com/firefly-services/docs/guides/
🔗
Usage Notes
https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/
🔗
Overview
https://developer.adobe.com/creative-cloud-libraries/docs/overview/
🔗
Integration Guide
https://developer.adobe.com/creative-cloud-libraries/docs/integrate/
🔗
API Fundamentals
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-fundamentals
🔗
Developer Guide
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
🔗
REST API
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api
🔗
REST API
https://developer.adobe.com/commerce/webapi/rest/
🔗
GraphQL API
https://developer.adobe.com/commerce/webapi/graphql-api/
🔗
REST API Reference
https://developer.adobe.com/commerce/webapi/reference/rest/paas/
🔗
GraphQL
https://artifacts.apis.io/adobe-suite/graphql/adobe-suite-graphql.md
🔗
Webhooks
https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/
🔗
StatusPage
https://status.adobe.com/

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/adobe-suite:adobe-suite-annotations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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.

OpenAPI Specification

adobe-suite-annotations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The endpoints described here are routed through analytics.adobe.io.
  title: Adobe Analytics Annotations API
  version: '2.0'
servers:
- url: https://analytics.adobe.io/api
tags:
- name: Annotations
paths:
  /{globalCompanyId}/annotations:
    get:
      tags:
      - Annotations
      summary: Retrieve all annotations
      description: ''
      operationId: getAnnotations_1
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: expansion
        in: query
        description: Comma-delimited list of additional annotation metadata fields to include on response.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - description
            - dateRange
            - color
            - applyToAllReports
            - scope
            - createdDate
            - modifiedDate
            - modifiedById
            - owner
            - companyId
            - rsid
            - approved
            - favorite
            - shares
            - sharesFullName
            - tags
            - usageSummary
            - usageSummaryWithRelevancyScore
            - ownerFullName
            - reportSuiteName
      - name: includeType
        in: query
        description: Include additional annotations not owned by user. The "all" option takes precedence over "shared"
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - shared
      - name: locale
        in: query
        description: Locale
        required: false
        schema:
          type: string
          default: en_US
      - name: filterByIds
        in: query
        required: false
        schema:
          type: string
      - name: filterByModifiedAfter
        in: query
        description: Filter list to only include annotations modified since this date (ISO8601 format)
        required: false
        schema:
          type: string
      - name: filterByDateRange
        in: query
        description: Filter list to only include annotations in the specified date range with format yyyy-MM-dd'T'HH:mm:ss/yyyy-MM-dd'T'hh:MM:ss
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results per page
        required: false
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Page number (base 0 - first page is "0")
        required: false
        schema:
          type: integer
          default: 0
      - name: sortDirection
        in: query
        description: Sort direction (ASC or DESC
        required: false
        schema:
          type: integer
          default: ASC
      - name: sortProperty
        in: query
        description: Property to sort by (name, modified_date, id is currently allowed)
        required: false
        schema:
          type: string
          default: id
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsAnnotation'
    post:
      tags:
      - Annotations
      summary: Create new annotation
      description: ''
      operationId: createAnnotation_1
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: expansion
        in: query
        description: Comma-delimited list of additional annotation metadata fields to include on response.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - description
            - dateRange
            - color
            - applyToAllReports
            - scope
            - createdDate
            - modifiedDate
            - modifiedById
            - owner
            - companyId
            - rsid
            - approved
            - favorite
            - shares
            - sharesFullName
            - tags
            - usageSummary
            - usageSummaryWithRelevancyScore
            - ownerFullName
            - reportSuiteName
      - name: locale
        in: query
        description: Locale
        required: false
        schema:
          type: string
          default: en_US
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsAnnotation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyticsAnnotation'
        description: JSON-formatted Object containing date range keys/value pairs to be updated.
  /{globalCompanyId}/annotations/{id}:
    get:
      tags:
      - Annotations
      summary: Get existing annotation
      description: ''
      operationId: getAnnotation_1
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: expansion
        in: query
        description: Comma-delimited list of additional annotation metadata fields to include on response.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - description
            - dateRange
            - color
            - applyToAllReports
            - scope
            - createdDate
            - modifiedDate
            - modifiedById
            - owner
            - companyId
            - rsid
            - approved
            - favorite
            - shares
            - sharesFullName
            - tags
            - usageSummary
            - usageSummaryWithRelevancyScore
            - ownerFullName
            - reportSuiteName
      - name: id
        in: path
        description: Annotation ID to retrieve
        required: true
        schema:
          type: string
      - name: locale
        in: query
        description: Locale
        required: false
        schema:
          type: string
          default: en_US
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsAnnotation'
    put:
      tags:
      - Annotations
      summary: Update existing annotation
      description: ''
      operationId: updateAnnotation_1
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: expansion
        in: query
        description: Comma-delimited list of additional annotation metadata fields to include on response.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - description
            - dateRange
            - color
            - applyToAllReports
            - scope
            - createdDate
            - modifiedDate
            - modifiedById
            - owner
            - companyId
            - rsid
            - approved
            - favorite
            - shares
            - sharesFullName
            - tags
            - usageSummary
            - usageSummaryWithRelevancyScore
            - ownerFullName
            - reportSuiteName
      - name: id
        in: path
        description: Annotation ID to update
        required: true
        schema:
          type: string
      - name: locale
        in: query
        description: Locale
        required: false
        schema:
          type: string
          default: en_US
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsAnnotation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyticsAnnotation'
        description: JSON-formatted Object containing date range keys/value pairs to be updated.
    delete:
      tags:
      - Annotations
      summary: Delete existing annotation
      description: ''
      operationId: deleteAnnotation_1
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: id
        in: path
        description: Annotation ID to update
        required: true
        schema:
          type: string
      - name: locale
        in: query
        description: Locale
        required: false
        schema:
          type: string
          default: en_US
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
components:
  schemas:
    ScopeFilter:
      type: object
      properties:
        id:
          type: string
        operator:
          type: string
        dimensionType:
          type: string
        terms:
          type: array
          items:
            type: string
        componentType:
          type: string
    AnalyticsAnnotation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        dateRange:
          type: string
        color:
          type: string
          enum:
          - STANDARD1
          - STANDARD2
          - STANDARD3
          - STANDARD4
          - STANDARD5
          - STANDARD6
          - STANDARD7
          - STANDARD8
          - STANDARD9
        applyToAllReports:
          type: boolean
        scope:
          $ref: '#/components/schemas/AnnotationScope'
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedById:
          type: string
        tags:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
        shares:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
        approved:
          type: boolean
        favorite:
          type: boolean
        usageSummary:
          type: object
          additionalProperties:
            type: object
        systemUserOwned:
          type: boolean
        owner:
          $ref: '#/components/schemas/Owner'
        companyId:
          type: integer
          format: int32
        reportSuiteName:
          type: string
        rsid:
          type: string
    DeleteResponse:
      type: object
      properties:
        result:
          type: string
        message:
          type: string
    AnnotationScope:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/ScopeMetric'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ScopeFilter'
    ScopeMetric:
      type: object
      properties:
        id:
          type: string
        componentType:
          type: string
    Owner:
      type: object
      required:
      - id
      properties:
        id:
          type: integer
          format: int32
          description: the login id of the owner
        name:
          type: string
          description: the friendly full login name of the owner, included when the expansion parameter ownerFullName is true
        login:
          type: string
          description: the friendly full login name of the owner, included when the expansion parameter ownerFullName is true
  parameters:
    x-api-key:
      name: x-api-key
      in: header
      description: The API key copied from your AA API client integration. For more information on how to obtain this value, see [Getting started with the Analytics API](https://developer.adobe.com/analytics-apis/docs/2.0/guides/).
      required: true
      schema:
        type: string
    authorization:
      name: Authorization
      in: header
      description: The access token copied from your AA API client integration, prefixed with "Bearer ".
      required: true
      schema:
        type: string