Campaigns — API Reference

Prepare personalized communication for your Customers

120 endpoints across 7 tags.

Screen views

• GET /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/screen-views/create — Create screen view
• POST /schema-service/v2/screen-views/createNew — Initialize screen view
• POST /schema-service/v2/screen-views/{screenViewId}/content — Add content to screen view
• POST /schema-service/v2/screen-views/{screenViewId}/audience — Add audience to screen view
• PUT /schema-service/v2/screen-views/{screenViewId}/priority — Update screen view priority
• PUT /schema-service/v2/screen-views/{screenViewId}/name — Rename screen view
• POST /schema-service/v2/screen-views/{feedSlug}/generate/by/{identifierType} — Preview screen view with a profile context
• GET /schema-service/v2/screen-views/feeds — List screen view feeds
• POST /schema-service/v2/screen-views/feeds — Create screen view feed
• GET /schema-service/v2/screen-views — List screen views
• GET /schema-service/v2/screen-views/{screenViewId} — Get screen view
• DELETE /schema-service/v2/screen-views/{screenViewId} — Delete screen view
• POST /schema-service/v2/screen-views/{screenViewId}/copy — Copy screen view
• GET /schema-service/v2/screen-views/{screenViewId}/predecessors — Get predecessors for screen view
• GET /schema-service/v2/screen-views/{screenViewId}/successors — Get successors for screen view
• GET /schema-service/v2/screen-views/directory — List screen view directories
• POST /schema-service/v2/screen-views/directory — Add screen view directory
• POST /schema-service/v2/screen-views/directory/{directoryId} — Rename screen view directory
• DELETE /schema-service/v2/screen-views/directory/{directoryId} — Delete screen view directory
• POST /schema-service/v2/screen-views/{screenViewId}/directory/{directoryId}/attach — Assign screen view to directory
• POST /schema-service/v2/screen-views/{screenViewId}/feed — Assign screen view to feed
• POST /schema-service/v2/screen-views/feeds/{feedId} — Rename screen view feed
• DELETE /schema-service/v2/screen-views/feeds/{feedId} — Delete screen view feed
• POST /schema-service/scheduler/entry — Schedule object
• GET /schema-service/scheduler/entry/{objectType}/{objectId} — Get schedule the schedule of an object
• POST /schema-service/v2/screen-views/{screenViewId}/status/finish — Finish screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/resume — Resume screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/activate — Activate screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/pause — Pause screen view

Recommendation campaigns

• GET /recommendation-campaigns/recommendations/v2/campaigns — Get all recommendation campaigns
• POST /recommendation-campaigns/recommendations/v2/campaigns — Create a recommendation campaign
• GET /recommendation-campaigns/recommendations/v2/campaigns/{campaignId} — Get recommendation campaign details
• POST /recommendation-campaigns/recommendations/v2/campaigns/{campaignId} — Update a recommendation campaign
• DELETE /recommendation-campaigns/recommendations/v2/campaigns/{campaignId} — Delete a recommendation campaign
• POST /recommendation-campaigns/recommendations/v2/campaigns/state — Change campaigns' states
• POST /recommendation-campaigns/recommendations/v2/campaigns/{campaignId}/copy — Copy a recommendation campaign
• GET /recommendation-campaigns/recommendations/v2/campaigns/simplified — Get simplified recommendation campaigns

Recommendation statistics

• POST /ai-stats/recommendations/v2/campaigns/stats — Get recommendation campaign statistics
• GET /ai-stats/recommendations/v2/campaigns/stats/global — Get global recommendation campaign statistics
• GET /ai-stats/recommendations/v2/campaigns/{campaignId}/stats — Get recommendation campaign statistics
• GET /ai-stats/recommendations/v2/campaigns/{campaignId}/products/stats — Get statistics for top items in a campaign

Recommendations

• GET /recommendations-api-materializer/recommendations/v2/recommend/campaigns/{campaignIdentifier} — Get recommendations by campaign
• POST /recommendations-api-materializer/recommendations/v2/recommend/campaigns — Get recommendations by campaign
• POST /recommendations-api-materializer/recommendations/v2/recommend/campaigns/{campaignIdentifier}/by/{identifierName} — Get recommendations by campaign and profile identifier
• POST /recommendations-api-materializer/recommendations/v2/recommend/campaigns/preview — Preview campaign recommendations
• GET /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid}/sections — Section recommendations
• POST /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid}/attributes — Attribute recommendations
• GET /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• POST /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• GET /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• POST /recommendations-rust-all/recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• GET /recommendations-rust-all/recommendations/v2/recommend/items/metric — Scoring by metric
• POST /recommendations-rust-all/recommendations/v2/recommend/items/metric — Scoring by metric
• GET /recommendations-rust-all/recommendations/v2/recommend/items/complementary — Complementary items for a cart
• POST /recommendations-rust-all/recommendations/v2/recommend/items/complementary — Complementary items for a cart
• GET /recommendations-rust-all/recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• POST /recommendations-rust-all/recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• GET /recommendations-rust-all/recommendations/v2/recommend/items/{itemId}/similar — Similar items
• POST /recommendations-rust-all/recommendations/v2/recommend/items/{itemId}/similar — Similar items
• GET /recommendations-rust-all/recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• POST /recommendations-rust-all/recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• GET /recommendations-rust-all/recommendations/v2/recommend/items/next-interaction — Next interaction
• POST /recommendations-rust-all/recommendations/v2/recommend/items/next-interaction — Next interaction
• GET /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid}/sections — Section recommendations
• POST /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid}/attributes — Attribute recommendations
• GET /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• POST /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• GET /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• POST /recommendations-rust/recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• GET /recommendations-rust/recommendations/v2/recommend/items/metric — Scoring by metric
• POST /recommendations-rust/recommendations/v2/recommend/items/metric — Scoring by metric
• GET /recommendations-rust/recommendations/v2/recommend/items/complementary — Complementary items for a cart
• POST /recommendations-rust/recommendations/v2/recommend/items/complementary — Complementary items for a cart
• GET /recommendations-rust/recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• POST /recommendations-rust/recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• GET /recommendations-rust/recommendations/v2/recommend/items/{itemId}/similar — Similar items
• POST /recommendations-rust/recommendations/v2/recommend/items/{itemId}/similar — Similar items
• GET /recommendations-rust/recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• POST /recommendations-rust/recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• GET /recommendations-rust/recommendations/v2/recommend/items/next-interaction — Next interaction
• POST /recommendations-rust/recommendations/v2/recommend/items/next-interaction — Next interaction

Templates

• GET /template-backend/template — List templates
• POST /template-backend/template — Create template
• GET /template-backend/template/{templateUuid} — Get template by UUID
• PATCH /template-backend/template/{templateUuid} — Patch a template
• POST /template-backend/template/functional — Create functional template
• POST /template-backend/template/move — Move templates to another directory
• POST /template-backend/template/remove — Remove templates
• GET /template-backend/template/getById/{id} — Get template by ID
• POST /template-backend/upload/zip — Create template from ZIP
• POST /template-backend/upload/url — Create template from URL

Template directories

• GET /template-backend/directory — Get directories
• POST /template-backend/directory — Create directory
• GET /template-backend/directory/byType — Get directories by type
• PATCH /template-backend/directory/{directoryUUID} — Rename directory
• DELETE /template-backend/directory/{directoryUUID} — Remove directory

Screen views (legacy)

• GET /schema-service/screenViews — Get all screen views (deprecated)
• POST /schema-service/screenViews/byKeys — Get screen views by keys (deprecated)
• GET /schema-service/screenViews/single/{screenViewId}/{screenViewVersion} — Get screen view (deprecated)
• GET /schema-service/screenViews/versions/{screenViewId} — Get screen view versions (deprecated)
• GET /schema-service/screenViews/generate — Generate screen view (deprecated)
• GET /schema-service/v2/screenViews/generate — Generate screen view (deprecated)
• POST /schema-service/screenViews/createNew — Initialize screen view (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion}/copyFromExistingScreenView — Copy content (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion} — Add content (deprecated)
• POST /schema-service/screenViews/audience/{screenViewId}/{screenViewVersion} — Add audience (deprecated)
• POST /schema-service/screenViews/publish/{screenViewId}/{screenViewVersion} — Publish screen view (deprecated)
• POST /schema-service/screenViews/copyDraftFromExistingScreenView — Copy draft from existing screen view (deprecated)
• POST /schema-service/screenViews/createDraftFromExistingScreenView — Create draft from existing screen view (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/description — Update screen view description (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/priority — Update screen view priority (deprecated)
• POST /schema-service/screenViews/discardChanges/{screenViewId}/{screenViewVersion} — Discard changes (deprecated)
• DELETE /schema-service/screenViews/delete/{screenViewId} — Delete screen view (deprecated)
• DELETE /schema-service/screenViews/single/delete/{screenViewId}/{screenViewVersion} — Delete screen view version (deprecated)

Back to all API categories