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.0.4, 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.
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.
GET
/campaign/boost/insights
Returns an attributed view of the aggregated boosting profile.
GET
/campaign/boost/status
Returns the current boost status including active and inactive campaigns.
GET
/campaign/{campaignId}
Retrieves the details of a specific campaign.
PATCH
/campaign/{campaignId}
Updates the specified campaign's properties.
GET
/campaign/boost/{externalCampaignId}/fast-bid-multiplier
Returns the fast bid multiplier currently applied to an external booster campaign.
PUT
/campaign/boost/{externalCampaignId}/fast-bid-multiplier
Sets the fast bid multiplier for a single external booster campaign to an arbitrary value.
GET
/campaign/monitor
Exercises the rapid-bag pipeline with a synthetic user profile so the health of the campaign monitoring path can be probed externally.
POST
/campaign/{campaignId}/pause
Pauses the specified campaign.
POST
/campaign/boost/preheat
Triggers a preheat pass for the boost subsystem so warm caches are ready before traffic spikes.
GET
/campaigns
Queries campaigns with optional filtering, sorting, and pagination.
POST
/campaign/{campaignId}/resume
Resumes the specified campaign.
PUT
/campaign/boost/global-level
Sets or clears the manual global boost level.
PUT
/campaign/{campaignId}/program
Replaces the campaign's stream program.
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), GetBoostInsightsEndpoint_Output (6 properties). Each schema is shown below with its type and property counts.
GetBoostInsightsEndpoint_GlobalBoostOutput
object
2 properties
2 required
ICampaignFilterModel
object
1 required
BoostingProfileModel
object
6 properties
4 required
ICampaignFilterModelOrFilterModel
object
2 properties
2 required
GetBoostInsightsEndpoint_LevelContributorOutput
object
3 properties
3 required
ICampaignFilterModelDeviceFilterModel
object
2 properties
2 required
CreateProgramCampaignEndpoint_Output
object
1 property
1 required
BoostingControlMode
RetrievalMode
ICampaignFilterModelUserActionRestrictionFilterModel
object
2 properties
2 required
ICampaignSelectionModelLabelingSelectionModel
object
5 properties
3 required
FeatureFlag
object
2 properties
2 required
ICampaignFilterModelNotFilterModel
object
2 properties
2 required
ICampaignSelectionModelDemographicSelectionModel
object
4 properties
3 required
AudienceBoostModel
object
2 properties
2 required
IProgramNodeModelActionNodeModel
object
2 properties
2 required
ICampaignSelectionModelAudienceSelectionModel
object
5 properties
4 required
ICampaignSelectionModelAbTestSelectionModel
object
3 properties
3 required
ICampaignFilterModelDemographicFilterModel
object
3 properties
3 required
ICampaignSelectionModelEnforcingSelectionModel
object
4 properties
4 required
ICooldownDurationModelRandomCooldownDurationModel
object
4 properties
4 required
ICampaignFilterModelCampaignSessionCountFilterModel
object
3 properties
3 required
IProgramPredicateModelCorrectCountPredicateModel
object
3 properties
3 required
CampaignStatusModel
ICampaignSelectionModelShufflingSelectionModel
object
2 properties
2 required
SetManualGlobalBoostLevelEndpoint_Input
object
1 property
IProgramActionModelCompleteActionModel
object
1 property
1 required
ComparisonOperator
IProgramNodeModel
object
1 required
IProgramPredicateModelAnsweredCountPredicateModel
object
3 properties
3 required
ValidationProblemDetails
object
6 properties
UpdateCampaignEndpoint_Input
object
8 properties
GetBoostInsightsEndpoint_Output
object
6 properties
6 required
ICampaignSelectionModelValidationSelectionModel
object
4 properties
2 required
ProgramCaseModel
object
2 properties
2 required
ICampaignFilterModelCampaignCooldownFilterModel
object
2 properties
2 required
IProgramActionModelServeRapidActionModel
object
3 properties
2 required
ICampaignSelectionModelConditionalValidationSelectionModel
object
3 properties
3 required
ValidationChanceModel
object
4 properties
3 required
ICampaignFilterModelLanguageFilterModel
object
2 properties
2 required
ICampaignFilterModelAndFilterModel
object
2 properties
2 required
UpdateStreamProgramEndpoint_Input
object
4 properties
4 required
CreateProgramCampaignEndpoint_Input
object
6 properties
6 required
GetCampaignByIdEndpoint_Output
object
14 properties
14 required
SetFastBidMultiplierEndpoint_Input
object
1 property
1 required
GetFastBidMultiplierEndpoint_Output
object
2 properties
2 required
StickyConfigModel
object
6 properties
5 required
ICampaignFilterModelCountryFilterModel
object
2 properties
2 required
DeviceType
ICampaignFilterModelNewUserFilterModel
object
1 property
1 required
ICampaignFilterModelUserScoreFilterModel
object
4 properties
4 required
ICampaignFilterModelCampaignIdFilterModel
object
2 properties
2 required
BoostStatusModel
ICooldownDurationModel
object
1 required
ProgramComparisonModel
IProgramActionModel
object
1 required
QueryCampaignsEndpoint_Output
object
9 properties
9 required
ICampaignFilterModelResponseCountFilterModel
object
4 properties
4 required
ICooldownDurationModelFixedCooldownDurationModel
object
2 properties
2 required
GetBoostInsightsEndpoint_AudienceOutput
object
2 properties
2 required
IProgramNodeModelCasesNodeModel
object
3 properties
2 required
IProgramPredicateModel
object
1 required
ICampaignSelectionModelCappedSelectionModel
object
3 properties
3 required
ICampaignFilterModelAudienceStateFilterModel
object
4 properties
4 required
ICampaignSelectionModelStaticSelectionModel
object
2 properties
2 required
SetFastBidMultiplierEndpoint_Output
object
2 properties
2 required
GetBoostInsightsEndpoint_LeveledAudienceOutput
object
3 properties
3 required
BoostMode
GetBoostInsightsEndpoint_ContributorOutput
object
2 properties
2 required
ICampaignSelectionModel
object
1 required
SimplifiedAudienceUserState
QueryCampaignsEndpoint_PagedResultOfOutput
object
5 properties
4 required
GetBoostStatusEndpoint_Output
object
5 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rapidata 12
Other APIs Rapidata publishes across the network.
Rapidata Asset API
Rapidata Audience API
Rapidata BatchUpload API
Rapidata Benchmark API
Rapidata Billing API
Rapidata BillingAccount API
Rapidata Cache API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API
Rapidata Datapoints API
#Campaign