Adobe Suite

Adobe Suite Component Meta Data API

The Component Meta Data API from Adobe Suite — 10 operation(s) for component meta data.

GitHub OpenAPI

Operations 16

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}/componentmetadata/shares List components a user has shared out · Retrieve components shared by user #
Ask an LLM
“Which segments and projects have I shared with other people?”
“Can I list the shares a particular user has created, page by page?”
Tell an agent
List the components I have shared out in company {globalCompanyId}.
Show the shares created by user {userid} in {globalCompanyId}.
POST /{globalCompanyId}/componentmetadata/shares Share a segment or project with someone · Share component with user #
Ask an LLM
“How do I share one segment with a single colleague without touching its other shares?”
“Can I share a project with everyone in my organization at once?”
Tell an agent
Share {componentType} {componentId} with user {shareToId} in company {globalCompanyId}.
Add a {shareToType} share for component {componentId} in {globalCompanyId}, keeping existing shares.
PUT /{globalCompanyId}/componentmetadata/shares Overwrite who analytics components are shared with · Update shared components with users #
Ask an LLM
“Can I set the full share list for segments or other components in one call?”
“Does updating component shares wipe out the existing shares first?”
Tell an agent destructive · confirm first
Replace the shares on my components in company {globalCompanyId} with the list I give you.
Reset sharing for these components in {globalCompanyId} so only the users I name have access.
POST /{globalCompanyId}/componentmetadata/shares/component/search Search shares for specific components · Create search for shared components #
Ask an LLM
“Who has a given segment or calculated metric been shared with?”
“Can I look up the shares for a list of component IDs of one type?”
Tell an agent
Find the shares on {componentType} components {componentIds} in {globalCompanyId}.
Search component shares in {globalCompanyId}, page {page} with {limit} per page.
GET /{globalCompanyId}/componentmetadata/shares/{id} Retrieve a component share by ID · Retrieve details of share by ID #
Ask an LLM
“What does one component share record contain?”
“Can I look up the details of a share if I have its share ID?”
Tell an agent
Get share {id} in company {globalCompanyId}.
Show me the details of component share {id}.
DELETE /{globalCompanyId}/componentmetadata/shares/{id} Delete a component share · Delete share by ID #
Ask an LLM
“Can I delete a share so it is removed from every component it was on?”
“How do I revoke a single component share by its share ID?”
Tell an agent destructive · confirm first
Delete share {id} in company {globalCompanyId}.
Revoke component share {id} from all its components.
GET /{globalCompanyId}/componentmetadata/shares/sharedto/me List components shared with me · Retrieve component IDs shared with user #
Ask an LLM
“Which segments have other people shared with me in Adobe Analytics?”
“Can I see component IDs of a certain type that were shared to my user?”
Tell an agent
List the {componentType} components shared with me in {globalCompanyId}.
Show which {componentType} IDs other users have shared to me.
POST /{globalCompanyId}/componentmetadata/tags/component/search Search tags applied to components · Create search for component tags #
Ask an LLM
“Which tags are attached to a list of analytics components?”
“Can I search component tags by component type and ID?”
Tell an agent
Find the tags on {componentType} components {componentIds} in {globalCompanyId}.
Search component tags in {globalCompanyId}, returning page {page}.
GET /{globalCompanyId}/componentmetadata/tags List all component tags for my company · Retrieve tags for current user company #
Ask an LLM
“What tags does my Analytics company use for organizing components?”
“Can I page through every tag defined for the company?”
Tell an agent
List all tags in company {globalCompanyId}.
Show tags for {globalCompanyId}, {limit} per page.
POST /{globalCompanyId}/componentmetadata/tags Create tags and apply them to a component · Create tags for current user company #
Ask an LLM
“How do I create a new tag and put it on a component?”
“Can I add fresh tags for my company while tagging a segment?”
Tell an agent
Create the tags I list in company {globalCompanyId} and apply them to my component.
Add a new tag in {globalCompanyId} for the segment I name.
DELETE /{globalCompanyId}/componentmetadata/tags Remove all tags from components · Delete tags from components #
Ask an LLM
“Can I strip every tag from a set of components at once?”
“Is untagging several components a single combined operation?”
Tell an agent destructive · confirm first
Remove all tags from {componentType} components {componentIds} in {globalCompanyId}.
Clear the tags on components {componentIds}.
GET /{globalCompanyId}/componentmetadata/tags/search Get the tags on one component · Retrieve component tags by component ID and component type #
Ask an LLM
“What tags are currently on a specific segment?”
“Can I list the tags for a single component ID?”
Tell an agent
Show the tags on {componentType} {componentId} in {globalCompanyId}.
List tags attached to segment {componentId}.
PUT /{globalCompanyId}/componentmetadata/tags/tagitems Overwrite the tags on components · Update tags for component #
Ask an LLM
“Can I replace a component's tags so only the ones I pass remain?”
“Does setting tag items delete the tags already associated with a component?”
Tell an agent destructive · confirm first
Set the tags on my components in {globalCompanyId} to exactly the list I give you.
Overwrite component tag associations in company {globalCompanyId}.
GET /{globalCompanyId}/componentmetadata/tags/{id} Retrieve a tag by ID · Retrieve tag by ID #
Ask an LLM
“What is the name and description of a tag with a given ID?”
“Can I fetch one tag record directly?”
Tell an agent
Get tag {id} in company {globalCompanyId}.
Show me tag {id}.
DELETE /{globalCompanyId}/componentmetadata/tags/{id} Delete a tag everywhere it is used · Delete tag from component #
Ask an LLM
“If I delete a tag, is it removed from every component that had it?”
“How do I delete a tag by its tag ID?”
Tell an agent destructive · confirm first
Delete tag {id} in company {globalCompanyId}.
Remove tag {id} from all components.
GET /{globalCompanyId}/componentmetadata/tags/tagnames Find components by tag name · Retrieve component IDs associated with tag names #
Ask an LLM
“Which segments are tagged with a particular tag name?”
“Can I look up components using several tag names at once?”
Tell an agent
Find {componentType} components tagged {tagNames} in {globalCompanyId}.
List component IDs carrying the tags {tagNames}.

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://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-component-meta-data-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://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/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-component-meta-data-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-component-meta-data-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The endpoints described here are routed through analytics.adobe.io.
  title: Adobe Analytics Component Meta Data API
  version: '2.0'
servers:
- url: https://analytics.adobe.io/api
tags:
- name: Component Meta Data
paths:
  /{globalCompanyId}/componentmetadata/shares:
    get:
      tags:
      - Component Meta Data
      summary: Retrieve components shared by user
      description: ''
      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: includeType
        in: query
        description: Include additional shares not owned by the user
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sharedTo
      - name: userid
        in: query
        description: The user ID to return details for. Only admins may use this option.
        required: false
        schema:
          type: integer
          format: int32
      - 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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Share'
        '500':
          description: Unable to retrieve list of components.
      operationId: getByGlobalCompanyIdComponentmetadataShares
      x-operation-id-source: derived
    post:
      tags:
      - Component Meta Data
      summary: Share component with user
      description: 'Note that only the following component types are currently supported: "segment", "project"

        There are three valid values for "shareToType":

        "all": Shares the component to all users in the organization. For this operation, "shareToId" is not required (ignored if sent)

        "user": Shares the component with a specific user. For this operation, "shareToId" (the loginId of the user to share to) is required.

        "group": Shares the component with an entire custom user group as defined in the Admin Console. For this operation, "shareToId" (the groupId of the group to share to) is required.'
      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: 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/Share'
        '500':
          description: Unable to share component
        '403':
          description: Permission error; user does not have access share the component
        '400':
          description: Invalid component type
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Share'
        description: JSON-formatted Share object containing key-value pairs that conform to the Share schema
      operationId: postByGlobalCompanyIdComponentmetadataShares
      x-operation-id-source: derived
    put:
      tags:
      - Component Meta Data
      summary: Update shared components with users
      description: 'Warning: Deletes and overwrites all pre-existing shares for given components. Create one/many shares for one/many components at once. For each component object in the passed list, the given shares will replace the current set of shares for each component. For example, if one of the components was previously shared with additional users, and that share is not passed in here, it will no longer be shared with them.'
      operationId: modifyShares
      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: locale
        in: query
        description: Locale
        required: false
        schema:
          type: string
          default: en_US
      - name: useCache
        in: query
        description: Use caching for faster requests
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedComponent'
        '500':
          description: Unable to save list of component shares
        '403':
          description: Permission error; user does not have access for the requested operation
        '400':
          description: Invalid component type, or mixed component types on request (only one type per request)
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SharedComponent'
        description: JSON-formatted ARRAY of objects containing key-value pairs that conform to the schema
  /{globalCompanyId}/componentmetadata/shares/component/search:
    post:
      tags:
      - Component Meta Data
      summary: Create search for shared components
      description: ''
      operationId: searchComponentTags
      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: locale
        in: query
        description: Locale
        required: false
        schema:
          type: string
          default: en_US
      - name: expansion
        in: query
        description: Comma-delimited list of additional project metadata fields to include on response.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sharesFullName
      - 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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedSharedComponent'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentSearch'
        description: items to search for
  /{globalCompanyId}/componentmetadata/shares/{id}:
    get:
      tags:
      - Component Meta Data
      summary: Retrieve details of share by ID
      description: ''
      operationId: getShare
      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: The share ID to return details for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Share'
        '500':
          description: Unable to retrieve share
        '403':
          description: Permission error; user does not have access to the share
        '400':
          description: Invalid component type
    delete:
      tags:
      - Component Meta Data
      summary: Delete share by ID
      description: Delete by shareId and remove that share from all associated components.
      operationId: deleteShare_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: The shareId to be deleted
        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:
                type: object
                additionalProperties:
                  type: object
        '500':
          description: Unable to delete share
        '403':
          description: Permission error; user does not have access to delete the component
  /{globalCompanyId}/componentmetadata/shares/sharedto/me:
    get:
      tags:
      - Component Meta Data
      summary: Retrieve component IDs shared with user
      description: ''
      operationId: findAllSharesToCurrentUser
      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: componentType
        in: query
        description: ComponentType to return
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                uniqueItems: true
  /{globalCompanyId}/componentmetadata/tags/component/search:
    post:
      tags:
      - Component Meta Data
      summary: Create search for component tags
      description: ''
      operationId: searchComponentTags_2
      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: 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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaggedComponent'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentSearch'
        description: items to search for
  /{globalCompanyId}/componentmetadata/tags:
    get:
      tags:
      - Component Meta Data
      summary: Retrieve tags for current user company
      description: ''
      operationId: findAllForCompany
      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: 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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tag'
        '500':
          description: Unable to retrieve list of tags for user.
    post:
      tags:
      - Component Meta Data
      summary: Create tags for current user company
      description: Allows creation of a new tag and applies that new tag to the passed component
      operationId: saveTagList
      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'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tag'
        '500':
          description: Unable to save list of tags.
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Tag'
        description: JSON-formatted array of Tag objects containing key-value pairs
    delete:
      tags:
      - Component Meta Data
      summary: Delete tags from components
      description: Removes all tags from the passed componentIds. Note that currently this is done in a single DB query, so there is a single combined response for the entire operation.
      operationId: deleteTagItems
      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: componentIds
        in: query
        description: Comma-separated list of componentIds to operate on.
        required: true
        schema:
          type: string
      - name: componentType
        in: query
        description: The component type to operate on.
        required: true
        schema:
          type: string
          enum:
          - segment
          - dashboard
          - bookmark
          - calculatedMetric
          - project
          - dateRange
          - metric
          - dimension
          - virtualReportSuite
          - scheduledJob
          - alert
          - classificationSet
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties:
                    type: object
        '500':
          description: Unable to remove tags for given components.
        '400':
          description: Invalid component type.
  /{globalCompanyId}/componentmetadata/tags/search:
    get:
      tags:
      - Component Meta Data
      summary: Retrieve component tags by component ID and component type
      description: Given a componentId, return all tags associated with that component
      operationId: getTagListByComponentIdAndComponentType
      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: componentId
        in: query
        description: The componentId to operate on. Currently this is just the segmentId.
        required: true
        schema:
          type: string
      - name: componentType
        in: query
        description: The component type to operate on.
        required: true
        schema:
          type: string
          enum:
          - segment
          - dashboard
          - bookmark
          - calculatedMetric
          - project
          - dateRange
          - metric
          - dimension
          - virtualReportSuite
          - scheduledJob
          - alert
          - classificationSet
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tag'
        '500':
          description: Unable to retrieve tags for given component.
        '400':
          description: Invalid component type.
  /{globalCompanyId}/componentmetadata/tags/tagitems:
    put:
      tags:
      - Component Meta Data
      summary: Update tags for component
      description: 'Warning: Deletes and overwrites all pre-existing associations. This endpoint allows many tags at once to be created/deleted. Any tags passed to this endpoint will become the *only* tags for that componentId (all other tags will be removed).'
      operationId: saveTagComponentList
      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'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaggedComponent'
        '500':
          description: Unable to save tag list.
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TaggedComponent'
        description: JSON-formatted object containing key-value pairs that conform to the schema
  /{globalCompanyId}/componentmetadata/tags/{id}:
    get:
      tags:
      - Component Meta Data
      summary: Retrieve tag by ID
      description: ''
      operationId: getTagById
      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: Tag ID to be retrieved
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
        '500':
          description: Unexpected server error while trying to retrieve tag
        '404':
          description: Unable to find a tag with the given ID
    delete:
      tags:
      - Component Meta Data
      summary: Delete tag from component
      description: Deletes by tag ID. This removes the tag from any or all components associated with the specified tag ID.
      operationId: deleteTag
      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: The tagId to be deleted
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties:
                    type: object
        '500':
          description: Unable to delete the given tagId.
        '404':
          description: The given tagId does not exist
  /{globalCompanyId}/componentmetadata/tags/tagnames:
    get:
      tags:
      - Component Meta Data
      summary: Retrieve component IDs associated with tag names
      description: Given a comma separated list of tag names, return component ids associated with them.
      operationId: getComponentsByTagName
      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: tagNames
        in: query
        description: Comma separated list of tag names.
        required: true
        schema:
          type: string
      - name: componentType
        in: query
        description: The component type to operate on.
        required: true
        schema:
          type: string
          enum:
          - segment
          - dashboard
          - bookmark
          - calculatedMetric
          - project
          - dateRange
          - metric
          - dimension
          - virtualReportSuite
          - scheduledJob
          - alert
          - classificationSet
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '500':
          description: Unable to retrieve tags for given component.
        '400':
          description: Invalid component type.
components:
  schemas:
    SharedComponent:
      type: object
      properties:
        componentType:
          type: string
        componentId:
          type: string
        shares:
          type: array
          items:
            $ref: '#/components/schemas/SharedToEntity'
    Share:
      type: object
      properties:
        shareId:
          type: string
        imsOrgId:
          type: string
        shareToId:
          type: integer
          format: int32
        shareToImsId:
          type: string
        shareToType:
          type: string
        shareFromImsId:
          type: string
        componentType:
          type: string
        componentId:
          type: string
        shareToDisplayName:
          type: string
        shareToLogin:
          type: string
        accessLevel:
          type: string
    SharedToEntity:
      type: object
      properties:
        shareToId:
          type: integer
          format: int32
        shareToImsId:
          type: string
        shareToType:
          type: string
        accessLevel:
          type: string
    TaggedComponent:
      type: object
      properties:
        componentType:
          type: string
        componentId:
          type: string
        tags:
          type: array
          items:
            type: string
    SavedSharedComponent:
      type: object
      properties:
        componentType:
          type: string
        componentId:
          type: string
        shares:
          type: array
          items:
            $ref: '#/components/schemas/Share'
    ComponentSearch:
      type: object
      properties:
        componentType:
          type: string
        componentIds:
          type: array
          uniqueItems: true
          items:
            type: string
    Tag:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: the tag id
        name:
          type: string
          description: 'the tag name '
        description:
          type: string
          description: the tag description
        components:
          type: array
          description: the list of components that have been tagged with this tag
          uniqueItems: true
          items:
            $ref: '#/components/schemas/TaggedComponent'
      description: Tag Model
  parameters:
    authorization:
      name: Authorization
      in: header
      description: The access token copied from your AA API client integration, prefixed with "Bearer ".
      required: true
      schema:
        type: string
    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