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 Segments API

Create, retrieve, update, and delete analytics segments

Adobe Analytics Segments 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 Segments. 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 5 operations across 2 paths, and defines 6 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}.

5 operations 2 paths 6 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.0
Server
https://analytics.adobe.io/api/{globalCompanyId}
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Adobe Analytics Segments 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 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.

Segments 5

Create, retrieve, update, and delete analytics segments

GET
/segments
Adobe Analytics List Segments
listSegments 6 params → 200401
POST
/segments
Adobe Analytics Create a Segment
createSegment body → 200400401
GET
/segments/{segmentId}
Adobe Analytics Get a Segment
getSegment 3 params → 200404
PUT
/segments/{segmentId}
Adobe Analytics Update a Segment
updateSegment 1 param body → 200404
DELETE
/segments/{segmentId}
Adobe Analytics Delete a Segment
deleteSegment 1 param → 200404

Schemas 6

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

SegmentList
object
Paginated list of segments
4 properties
Segment
object
An analytics segment definition
8 properties
Tag
object
A tag applied to an Analytics component
4 properties
ErrorResponse
object
Error response from the API
3 properties
Owner
object
The owner of an Analytics component
3 properties
SegmentCreate
object
Payload for creating or updating a segment
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adobe-analytics-segments-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 Annotations 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