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

BlueConic Segments API

A segment is a group of profiles characterized by a defined set of attributes & properties. The following methods allow you to retrieve information from segments and the profiles within a given segment. [Read more](https://support.blueconic.com/hc/en-us/articles/202531952-Segments?utm_source=BlueConic_User)

BlueConic Segments API is one of 28 APIs that BlueConic 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, a getting-started guide, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.3, at version 100.0.

Requests are made against a single base URL, https://{blueconicHostname}/rest/v2.

2 operations 2 paths 16 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
100.0
Base URL
https://{tenantname}.blueconic.net/rest/v2
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

BlueConic Segments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials and authorizationCode flows.

  • oauth2 — Authenticates a registered OAuth 2.0 client. The Authorization code flow and Client credentials flow are supported. Make sure to select the correct flow based…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Segments 2

A segment is a group of profiles characterized by a defined set of attributes & properties. The following methods allow you to retrieve information from segments and the profiles…

GET
/segments/{segment}/profiles
Get profiles in segment
getProfilesInSegment 19 params → 200400404401503
GET
/segments
Get all segments
getAllSegments 3 params → 200401503

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are profile (14 properties), RefinementBean (12 properties), segment (11 properties), SegmentProfiles (7 properties). Each schema is shown below with its type and property counts.

profile
object
The profiles that are in this segment.
14 properties
SegmentProfiles
object
7 properties
segments
object
5 properties
Property
object
3 properties
segment
object
The segments.
11 properties
simpleObject
object
2 properties
link
object
3 properties
group
object
Groups that the profile is a part of.
5 properties
matchingGroup
object
Groups that the profile is a part of and match the segment refinements.
2 properties
RefinementBean
object
12 properties
permissions
object
1 property
lifecycleStage
object
Lifecycle stages that the profile is part of.
2 properties
UserBean
object
BlueConic user.
2 properties
event
object
6 properties
property
object
A property consisting of an ID and a list of values.
2 properties
profileSegmentBean
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

blueconic-segments-api-openapi.yml Raw ↑

Other APIs BlueConic publishes across the network.

BlueConic Audit Events API
BlueConic Channels API
BlueConic Connections API
BlueConic Dialogues API
BlueConic Group Types API
BlueConic Groups API
BlueConic Interaction events API
BlueConic Interactions API
BlueConic Lifecycles API
BlueConic Listeners API
BlueConic Models API
BlueConic Notebooks API
Where this information came from

This is an independent, third-party profile of BlueConic 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.