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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Rapidata

Rapidata Audience API

The Audience API from Rapidata — 19 operation(s) for audience.

Documentation Provider Profile APIs.io OpenAPI GitHub

Rapidata Audience API is one of 55 APIs that Rapidata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Audience. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 23 operations across 19 paths, and defines 46 schemas. It is described by OpenAPI 3.0.4, at version v1.

Requests are made against a single base URL, https://api.rapidata.ai/.

23 operations 19 paths 46 schemas 1 DELETE8 GET3 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
v1
Base URL
https://api.rapidata.ai/
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

Rapidata Audience API declares 1 security scheme for authenticating requests. It supports OpenID Connect (OpenIdConnect) discovered at https://auth.rapidata.ai/.well-known/openid-configuration.

  • OpenIdConnect — OpenID Connect connection flow

Paths & Operations 23

Across 19 paths, the API surfaces 23 operations — 1 DELETE, 8 GET, 3 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Audience 23
PATCH
/audience/{audienceId}/owner
Changes the owner of the specified audience.
1 param body → 204400401403
POST
/audience
Creates a new empty audience.
body → 200400401403
POST
/audience/{baseAudienceId}/filter
Creates a filtered view on the given base audience by applying a filter on top of its graduates. Returns an audience id that can be used in job creation just like a regular audience id; no new onboar…
1 param body → 200400401403
DELETE
/audience/{audienceId}
Deletes the specified audience.
1 param → 204400401403
GET
/audience/{audienceId}
Returns the audience with the specified id.
1 param → 200400401403
PATCH
/audience/{audienceId}
Patches an existing audience.
1 param body → 200400401403
GET
/audience/inactivity-sync/{syncId}
Returns the audience inactivity sync with the given id.
1 param → 200400401403
GET
/audience/state-recalculation/{recalculationId}
Returns the audience state recalculation with the given id.
1 param → 200400401403
GET
/audience/{audienceId}/user-metrics
Gets the count of users in each state for the specified audience.
1 param → 200400401403
GET
/audience/{audienceId}/inactivity-sync
Returns the most recent audience inactivity sync for the given audience, regardless of state.
1 param → 200400401403
POST
/audience/{audienceId}/inactivity-sync
Starts a new inactivity sync for the given audience.
1 param → 200400401403
GET
/audience/{audienceId}/state-recalculation
Returns the most recent audience state recalculation for the given audience, regardless of state.
1 param → 200400401403
POST
/audience/{audienceId}/state-recalculation
Starts a new audience state recalculation for the given audience.
1 param → 200400401403
POST
/audience/{audienceId}/initialize-users
Uploads a CSV file containing user IDs and scores, then processes it in the background to seed the audience with those users.
1 param body → 202400401403
POST
/audience/{audienceId}/pause-distillation
Pauses the distillation campaign for the specified audience.
1 param → 204400401403
GET
/audience/{audienceId}/jobs
Queries jobs for the specified audience.
10 params → 200400401403
GET
/audiences
Queries all audiences visible to the caller.
10 params → 200400401403
POST
/audience/{audienceId}/rebuild-distilling-campaign
Rebuilds the distilling campaign for the specified audience.
1 param → 204400401403
POST
/audience/reconcile-user-counts
Enqueues a background job that reconciles audience-row state derived from audiencestatecounts.
→ 202400401403
POST
/audience/{audienceId}/recreate-external-audiences
Recreates external audiences for the specified audience.
1 param body → 204400401403
POST
/audience/{audienceId}/resume-distillation
Resumes the distillation campaign for the specified audience.
1 param → 204400401403
POST
/audience/{audienceId}/recruit
Starts recruiting users for the specified audience.
1 param → 204400401403
PATCH
/audience/{audienceId}/boost-config
Updates the boost configuration for the specified audience.
1 param body → 200400401403

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are GetAudienceByIdEndpoint_Output (32 properties), CreateAudienceEndpoint_Input (20 properties), UpdateAudienceEndpoint_Input (18 properties), QueryAudiencesEndpoint_Output (15 properties). Each schema is shown below with its type and property counts.

CreateFilteredAudienceEndpoint_Input
object
1 property 1 required
GetAudienceUserStateMetricsResult
object
1 property 1 required
UpdateBoostConfigEndpoint_Output
object
1 property
GetAudienceByIdEndpoint_Output
object
32 properties 14 required
IAudienceFilterDemographicAudienceFilter
object
3 properties 3 required
StartAudienceStateRecalculationEndpoint_Output
object
1 property 1 required
RetrievalMode
AudienceStateRecalculationPhase
MetadataVisibilities
array
BoostLevel
CreateAudienceEndpoint_Output
object
1 property 1 required
IAudienceFilterOrAudienceFilter
object
2 properties 2 required
GetLatestAudienceInactivitySyncEndpoint_Output
object
13 properties 8 required
GetAudienceStateRecalculationByIdEndpoint_Output
object
12 properties 7 required
ExistingAssetInput
object
3 properties 1 required
UpdateAudienceEndpoint_Output
object
2 properties
IAudienceFilterAndAudienceFilter
object
2 properties 2 required
CreateAudienceEndpoint_Input
object
20 properties 1 required
ValidationProblemDetails
object
6 properties
AudienceStatus
GetAudienceInactivitySyncByIdEndpoint_Output
object
13 properties 8 required
UpdateBoostConfigEndpoint_Input
object
2 properties
IFormFile
string
QueryAudienceJobsEndpoint_Output
object
8 properties 8 required
CreateFilteredAudienceEndpoint_Output
object
1 property 1 required
IMetadataInputTextMetadataInput
object
3 properties 3 required
RecreateExternalAudiencesEndpoint_Input
object
1 property 1 required
QueryAudiencesEndpoint_Output
object
15 properties 9 required
GetLatestAudienceStateRecalculationEndpoint_Output
object
12 properties 7 required
IAudienceFilterLanguageAudienceFilter
object
2 properties 2 required
DeviceType
IAudienceFilter
object
1 required
StartAudienceInactivitySyncEndpoint_Output
object
1 property 1 required
UpdateAudienceEndpoint_Input
object
18 properties
ChangeAudienceOwnerEndpoint_Input
object
2 properties 2 required
IAudienceFilterNotAudienceFilter
object
2 properties 2 required
AudienceStateRecalculationState
MetadataInputCollection
object
AudienceInactivitySyncPhase
QueryAudienceJobsEndpoint_PagedResultOfOutput
object
5 properties 4 required
IAudienceFilterDeviceAudienceFilter
object
2 properties 2 required
IMetadataInput
object
1 required
QueryAudiencesEndpoint_PagedResultOfOutput
object
5 properties 4 required
IAudienceFilterCountryAudienceFilter
object
2 properties 2 required
AudienceInactivitySyncState
AudienceJobState

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-audience-api-openapi.yml Raw ↑

Other APIs Rapidata publishes across the network.

Rapidata Asset API
AE Profile APIs.io
Rapidata BatchUpload API
AE Profile APIs.io
Rapidata Benchmark API
AE Profile APIs.io
Rapidata Billing API
AE Profile APIs.io
Rapidata BillingAccount API
AE Profile APIs.io
Rapidata Cache API
AE Profile APIs.io
Rapidata Campaign API
AE Profile APIs.io
Rapidata Client API
AE Profile APIs.io
Rapidata ContextShortening API
AE Profile APIs.io
Rapidata Customer API
AE Profile APIs.io
Rapidata CustomerRapid API
AE Profile APIs.io
Rapidata Datapoints API
AE Profile APIs.io
#Audience
← Back to R APIs
API Details
ID
rapidata:rapidata-audience-api
Base URL
https://api.rapidata.ai/
Docs
https://docs.rapidata.ai/developers/
Provider
Rapidata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network