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

Operations for managing analytics segments

Adobe Experience Cloud Segments API is one of 36 APIs that Adobe Experience Cloud 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 and API documentation.

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

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

9 operations 4 paths 5 schemas 2 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Server
https://analytics.adobe.io
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Adobe Experience Cloud Segments API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (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 obtained via Adobe I/O.
  • apiKey — Adobe I/O client API key.

Paths & Operations 9

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

Segments 9

Operations for managing analytics segments

GET
/api/{companyId}/segments
Adobe Analytics Adobe Experience Cloud List Segments
listSegments 4 params → 200401
POST
/api/{companyId}/segments
Adobe Analytics Adobe Experience Cloud Create a Segment
createSegment 1 param body → 200400401
GET
/api/{companyId}/segments/{segmentId}
Adobe Analytics Adobe Experience Cloud Get a Segment
getSegment 2 params → 200401404
PUT
/api/{companyId}/segments/{segmentId}
Adobe Analytics Adobe Experience Cloud Update a Segment
updateSegment 2 params body → 200400401404
DELETE
/api/{companyId}/segments/{segmentId}
Adobe Analytics Adobe Experience Cloud Delete a Segment
deleteSegment 2 params → 200401404
GET
/data/core/ups/segment/definitions
Adobe Experience Platform Adobe Experience Cloud List Segment Definitions
listSegmentDefinitions 2 params → 200401
POST
/data/core/ups/segment/definitions
Adobe Experience Platform Adobe Experience Cloud Create a Segment Definition
createSegmentDefinition 1 param body → 201400
GET
/data/core/ups/segment/definitions/{segmentId}
Adobe Experience Platform Adobe Experience Cloud Get a Segment Definition
getSegmentDefinition 2 params → 200404
DELETE
/data/core/ups/segment/definitions/{segmentId}
Adobe Experience Platform Adobe Experience Cloud Delete a Segment Definition
deleteSegmentDefinition 2 params → 204404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Segment (7 properties), SegmentDefinition (6 properties), SegmentDefinitionInput (5 properties), SegmentList (3 properties). Each schema is shown below with its type and property counts.

SegmentDefinitionInput
object
5 properties 4 required
Segment
object
7 properties
SegmentList
object
3 properties
SegmentDefinitionList
object
2 properties
SegmentDefinition
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adobe-experience-cloud-segments-api-openapi.yml Raw ↑

Other APIs Adobe Experience Cloud publishes across the network.

Adobe I/O Events
Adobe Experience Cloud Activities API
Adobe Experience Cloud Audiences API
Adobe Experience Cloud Batches API
Adobe Experience Cloud Calculated Metrics API
Adobe Experience Cloud Campaign API
Adobe Experience Cloud Campaigns API
Adobe Experience Cloud Classes API
Adobe Experience Cloud Collections API
Adobe Experience Cloud Content API
Adobe Experience Cloud Content Templates API
Adobe Experience Cloud Datasets API