How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Treasure Data Segments API

In marketing, a segment is a container that groups profiles (usually people) who share one or more common characteristics. In Treasure Data, the parent segment is your total population of people, accounts, or other type of collection and can be both existing and potential customers. You create segments to divide the population into subgroups of consumers based on some type of shared characteristics. Segments and subsegments enable more specific targeting for your marketing campaigns. _Treasure Data is making an effort to use more inclusive language in its product, content, and customer solutions. As we gradually make the move to replace insensitive language beginning in our UI, you may continue to see parent segments in the UI, for example, referenced as master segment in portions of Treasure Data APIs._

Treasure Data Segments API is one of 67 APIs that Treasure Data 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, and a getting-started guide.

This API exposes 16 operations across 11 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 5 base URLs: https://api-cdp.treasuredata.com, https://api-cdp.treasuredata.co.jp, https://api-cdp.eu01.treasuredata.com, https://api-cdp.ap02.treasuredata.com, https://api-cdp.ap03.treasuredata.com.

16 operations 11 paths 46 schemas 2 DELETE7 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.treasuredata.com/v3/bulk_loads
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Treasure Data Segments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (TdApikeyAuth).

Paths & Operations 16

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

Segments 16

In marketing, a segment is a container that groups profiles (usually people) who share one or more common characteristics. In Treasure Data, the parent segment is your total popul…

GET
/audiences/{audienceId}/segments
Retrieve list of segments
segments#index 1 param → 2004004014034044XX5XX
POST
/audiences/{audienceId}/segments
Create new segment
segments#create 1 param body → 4004014034044XX5XX
GET
/audiences/{audienceId}/folders/{folderId}/segments
Retrieve list of segments in a folder
segment_folders#segments 2 params → 2004004014034044XX5XX
POST
/audiences/{audienceId}/segments/query
Retrieve SQL from segment rule
segments#query 1 param body → 2004004014034044XX5XX
POST
/audiences/{audienceId}/segments/queries
Retrieve number of profiles based on set of segment rules
segments#new_query 1 param body → 2004004014034044XX5XX
GET
/audiences/{audienceId}/segments/{segmentId}
Retrieve segment by ID
segments#show 2 params → 2004004014034044XX5XX
PUT
/audiences/{audienceId}/segments/{segmentId}
Update segment
segments#update 2 params body → 2004004014034044XX5XX
DELETE
/audiences/{audienceId}/segments/{segmentId}
Delete segment (legacy)
segments#delete 2 params → 4004014034044XX5XX
GET
/audiences/{audienceId}/segments/queries/{queryId}
Retrieve status of query
segments#query_status 2 params → 2004004014034044XX5XX
POST
/audiences/{audienceId}/segments/queries/{queryId}/kill
Kill current running query of segment
segments#kill_query 2 params → 2004004014034044XX5XX
GET
/audiences/{audienceId}/segments/queries/{queryId}/customers
Retrieve profiles of query
segments#index_query_customers 3 params → 2004004014034044XX5XX
GET
/audiences/{audienceId}/segments/{segmentId}/statistics
Retrieve population statistics of segment
segments#statistics 4 params → 2004004014034044XX5XX
POST
/entities/segments
Create segment
body → 200
GET
/entities/segments/{id}
Retrieve segment by ID
1 param → 200
PATCH
/entities/segments/{id}
Update segment
1 param body → 200
DELETE
/entities/segments/{id}
Delete segment
1 param → 200

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Segment (13 properties), SegmentParameters (9 properties), SegmentQueryStatus (9 properties), partial_v5_rule.yaml-v5IonRule-localDuration (8 properties). Each schema is shown below with its type and property counts.

EntitiesSegmentUpdateRepresentation
object
4 properties
partial_v5_rule.yaml-v5IonRule-ionRule
object
4 properties 2 required
partial_v5_rule.yaml-v5IonRule
UserJsonApiResource
object
3 properties 3 required
partial_v5_rule.yaml-v5IonRule-attributeNameValue
object
1 property 1 required
partial_v5_rule.yaml-v5IonRule-valueOperator
ArrayMatching
partial_v5_rule.yaml-v5IonRule-valueLimit
object
3 properties 2 required
EntitiesGetSegmentJsonApiResponse
object
2 properties 2 required
SegmentQueryStatus
object
9 properties
ReferenceCondition
object
1 property
partial_v5_rule.yaml-v5IonRule-valueLeftValue
partial_v5_rule.yaml-v5IonRule-filter
SegmentParameters
object
9 properties
RelationshipsUserJsonApiResource
object
1 property
Operator
object
Value
User
object
3 properties
partial_v5_rule.yaml-v5IonRule-referenceCondition
RelationshipsFolderJsonApiResource
object
1 property
partial_v5_rule.yaml-v5IonRule-localDuration
object
8 properties
partial_v5_rule.yaml-v5IonRule-timeframeOperator
RealtimeSegmentJsonApiResource
object
4 properties 4 required
Statistic
array
Segment
object
13 properties
partial_v5_rule.yaml-v5IonRule-columnFilter
OrCondition
object
2 properties 2 required
SegmentRule
partial_v5_rule.yaml-v5IonRule-orFilter
object
2 properties 2 required
EmptyCondition
object
Condition
partial_v5_rule.yaml-v5IonRule-valueArrayMatching
partial_v5_rule.yaml-v5IonRule-duration
ValueCondition
object
4 properties
partial_v5_rule.yaml-v5IonRule-customerGroupAttributeValue
object
2 properties 2 required
partial_v5_rule.yaml-v5IonRule-valueConditionSet
object
4 properties 2 required
partial_v5_rule.yaml-v5IonRule-aggregationValue
object
4 properties 3 required
FunnelStageSegmentJsonApiResource
object
4 properties 4 required
AndCondition
object
2 properties 2 required
SegmentQueryCustomers
object
5 properties
CompositeCondition
object
3 properties 3 required
partial_v5_rule.yaml-v5IonRule-valueCondition
object
6 properties 5 required
partial_v5_rule.yaml-v5IonRule-unit
string
partial_v5_rule.yaml-v5IonRule-andFilter
object
2 properties 2 required
Error
object
2 properties 2 required
BatchSegmentJsonApiResource
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

treasure-data-segments-api-openapi.yml Raw ↑

Other APIs Treasure Data publishes across the network.

Treasure Data Bulk Loads API
Treasure Data User API
Treasure Data System API
Treasure Data Postback API
Treasure Workflow API
Treasure Data Bulk Import API
Treasure Data Bulk Loads API
Treasure Data Connectors API
Treasure Data Databases API
Treasure Data Jobs API
Treasure Data SSO API
Treasure Data System API
Where this information came from

This is an independent, third-party profile of Treasure Data Segments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.