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

Rapidata Campaign API

The Campaign API from Rapidata — 12 operation(s) for campaign.

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

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

This API exposes 14 operations across 12 paths, and defines 73 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

14 operations 12 paths 73 schemas 6 GET1 PATCH4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Rapidata Campaign 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 14

Across 12 paths, the API surfaces 14 operations — 6 GET, 1 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaign 14
POST
/campaign/program
Creates a program campaign from the given stream program
postCampaignProgram body → 200400401403
GET
/campaign/boost/insights
Returns an attributed view of the aggregated boosting profile
getCampaignBoostInsights → 200400401403
GET
/campaign/boost/status
Returns the current boost status including active and inactive campaigns
getCampaignBoostStatus → 200400401403
GET
/campaign/{campaignId}
Retrieves the details of a specific campaign
getCampaignByCampaignId 1 param → 200400401403
PATCH
/campaign/{campaignId}
Updates the specified campaign's properties
patchCampaignByCampaignId 1 param body → 204400401403
GET
/campaign/boost/{externalCampaignId}/fast-bid-multiplier
Returns the fast bid multiplier currently applied to an external booster…
getCampaignBoostByExternalCampaignIdFastBidMultiplier 1 param → 200400401403
PUT
/campaign/boost/{externalCampaignId}/fast-bid-multiplier
Sets the fast bid multiplier for a single external booster campaign to an…
putCampaignBoostByExternalCampaignIdFastBidMultiplier 1 param body → 200400401403
GET
/campaign/monitor
Exercises the rapid-bag pipeline with a synthetic user profile so the health of…
getCampaignMonitor → 200400
POST
/campaign/{campaignId}/pause
Pauses the specified campaign
postCampaignByCampaignIdPause 1 param → 204400401403
POST
/campaign/boost/preheat
Triggers a preheat pass for the boost subsystem so warm caches are ready before…
postCampaignBoostPreheat → 204400401403
GET
/campaigns
Queries campaigns with optional filtering, sorting, and pagination
getCampaigns 10 params → 200400401403
POST
/campaign/{campaignId}/resume
Resumes the specified campaign
postCampaignByCampaignIdResume 1 param → 204400401403
PUT
/campaign/boost/global-level
Sets or clears the manual global boost level
putCampaignBoostGlobalLevel body → 204400401403
PUT
/campaign/{campaignId}/program
Replaces the campaign's stream program
putCampaignByCampaignIdProgram 1 param body → 204400401403

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are GetCampaignByIdEndpoint_Output (14 properties), QueryCampaignsEndpoint_Output (9 properties), UpdateCampaignEndpoint_Input (8 properties), StickyConfigModel (6 properties). Each schema is shown below with its type and property counts.

ICooldownDurationModelRandomCooldownDurationModel
object
4 properties 4 required
ICooldownDurationModel
object
1 required
ICampaignFilterModelAudienceStateFilterModel
object
4 properties 4 required
StickyConfigModel
object
6 properties 5 required
GetBoostInsightsEndpoint_GlobalBoostOutput
object
2 properties 2 required
ICampaignSelectionModelDemographicSelectionModel
object
4 properties 3 required
IProgramNodeModelCasesNodeModel
object
3 properties 2 required
ComparisonOperator
IProgramPredicateModel
object
1 required
ProgramCaseModel
object
2 properties 2 required
ICampaignFilterModelLanguageFilterModel
object
2 properties 2 required
SimplifiedAudienceUserState
GetCampaignByIdEndpoint_Output
object
14 properties 14 required
GetBoostInsightsEndpoint_Output
object
6 properties 6 required
ICampaignFilterModelCampaignSessionCountFilterModel
object
3 properties 3 required
ICampaignFilterModelOrFilterModel
object
2 properties 2 required
BoostStatusModel
ICampaignSelectionModelLabelingSelectionModel
object
5 properties 3 required
IProgramActionModelCompleteActionModel
object
1 property 1 required
GetBoostInsightsEndpoint_LeveledAudienceOutput
object
3 properties 3 required
FeatureFlag
object
2 properties 2 required
GetBoostInsightsEndpoint_ContributorOutput
object
2 properties 2 required
QueryCampaignsEndpoint_Output
object
9 properties 9 required
ICampaignSelectionModelAbTestSelectionModel
object
3 properties 3 required
ICampaignSelectionModelStaticSelectionModel
object
2 properties 2 required
DeviceType
ICampaignSelectionModelConditionalValidationSelectionModel
object
3 properties 3 required
ICampaignFilterModelDemographicFilterModel
object
3 properties 3 required
GetFastBidMultiplierEndpoint_Output
object
2 properties 2 required
CreateProgramCampaignEndpoint_Output
object
1 property 1 required
IProgramPredicateModelCorrectCountPredicateModel
object
3 properties 3 required
ICampaignFilterModelNotFilterModel
object
2 properties 2 required
SetManualGlobalBoostLevelEndpoint_Input
object
1 property
ICampaignSelectionModel
object
1 required
ICampaignFilterModelDeviceFilterModel
object
2 properties 2 required
ICampaignFilterModelResponseCountFilterModel
object
4 properties 4 required
AudienceBoostModel
object
2 properties 2 required
ICampaignFilterModelCampaignIdFilterModel
object
2 properties 2 required
GetBoostInsightsEndpoint_LevelContributorOutput
object
3 properties 3 required
ICampaignFilterModelCountryFilterModel
object
2 properties 2 required
SetFastBidMultiplierEndpoint_Output
object
2 properties 2 required
CampaignStatusModel
RetrievalMode
UpdateCampaignEndpoint_Input
object
8 properties
ICampaignFilterModel
object
1 required
GetBoostInsightsEndpoint_AudienceOutput
object
2 properties 2 required
CreateProgramCampaignEndpoint_Input
object
6 properties 6 required
ICampaignSelectionModelEnforcingSelectionModel
object
4 properties 4 required
QueryCampaignsEndpoint_PagedResultOfOutput
object
5 properties 4 required
ICampaignSelectionModelValidationSelectionModel
object
4 properties 2 required
ICampaignFilterModelUserActionRestrictionFilterModel
object
2 properties 2 required
ICooldownDurationModelFixedCooldownDurationModel
object
2 properties 2 required
IProgramNodeModel
object
1 required
ICampaignFilterModelCampaignCooldownFilterModel
object
2 properties 2 required
IProgramActionModelServeRapidActionModel
object
3 properties 2 required
IProgramActionModel
object
1 required
ICampaignSelectionModelCappedSelectionModel
object
3 properties 3 required
ICampaignFilterModelAndFilterModel
object
2 properties 2 required
IProgramNodeModelActionNodeModel
object
2 properties 2 required
BoostMode
ValidationChanceModel
object
4 properties 3 required
UpdateStreamProgramEndpoint_Input
object
4 properties 4 required
ICampaignSelectionModelShufflingSelectionModel
object
2 properties 2 required
IProgramPredicateModelAnsweredCountPredicateModel
object
3 properties 3 required
SetFastBidMultiplierEndpoint_Input
object
1 property 1 required
BoostingControlMode
GetBoostStatusEndpoint_Output
object
5 properties 5 required
ValidationProblemDetails
object
6 properties
ICampaignFilterModelNewUserFilterModel
object
1 property 1 required
ICampaignFilterModelUserScoreFilterModel
object
4 properties 4 required
ProgramComparisonModel
BoostingProfileModel
object
6 properties 4 required
ICampaignSelectionModelAudienceSelectionModel
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-campaign-api-openapi.yml Raw ↑

Other APIs Rapidata publishes across the network.

Rapidata Asset API
Rapidata Audience API
Rapidata Benchmark API
Rapidata Billing API
Rapidata Cache API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API
Rapidata Datapoints API
Rapidata Dataset API
Rapidata DatasetGroup API
Where this information came from

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