openapi: 3.1.0 info: title: ows-campaigns description: Fansifter Campaigns Management Service version: 1.0.0 servers: - url: https://qa-ows-campaigns.theorchard.io paths: /hello/: get: tags: - infra summary: Hello operationId: hello_hello__get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HelloResponse' /errors: get: tags: - errors summary: Get Errors operationId: get_errors_errors_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/Error' type: array title: Response Get Errors Errors Get /assets/{assetId}: get: tags: - assets summary: Get Asset operationId: getAsset parameters: - description: Asset id or key required: true schema: type: string title: Assetid description: Asset id or key name: assetId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Asset' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - assets summary: Update Asset description: Asset partial update operationId: updateAsset parameters: - description: Asset id or key required: true schema: type: string title: Assetid description: Asset id or key name: assetId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAssetInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Asset' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /campaigns/statuses: get: tags: - campaigns summary: Get Campaigns Statuses operationId: getCampaignsStatuses responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/CampaignStatus' type: array /meta/campaigns/artists: get: tags: - campaigns summary: Get Campaigns Artists description: Get artists list for already created campaigns operationId: getMetaCampaignsArtists responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/Artist' type: array title: Response Getmetacampaignsartists deprecated: true security: - OrchardIdentityId: [] - OrchardProfileId: [] /campaigns/artists: get: tags: - campaigns summary: Get Campaigns Artists description: Get artists list for already created campaigns operationId: getCampaignsArtists responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/Artist' type: array title: Response Getcampaignsartists security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns: get: tags: - campaigns summary: Search Campaigns operationId: searchMetaCampaigns parameters: - description: Label id required: false schema: type: integer title: Vendorid description: Label id name: vendorId in: query - description: Label subaccount id required: false schema: type: integer title: Subaccountid description: Label subaccount id name: subaccountId in: query - description: Artist ids required: false schema: items: type: string type: array title: Globalparticipantids description: Artist ids name: globalParticipantIds in: query - description: Statuses required: false schema: items: $ref: '#/components/schemas/CampaignStatus' type: array description: Statuses name: statuses in: query - description: Objectives required: false schema: items: $ref: '#/components/schemas/CampaignObjective' type: array description: Objectives name: objectives in: query - description: Platforms required: false schema: items: $ref: '#/components/schemas/CampaignPlatform' type: array description: Platforms name: platforms in: query - description: A search term required: false schema: type: string title: Search description: A search term name: search in: query - description: Order by field(s) required: false schema: type: string title: Orderby description: Order by field(s) default: createdAt.desc name: orderBy in: query - description: Page size limit required: false schema: type: integer maximum: 100.0 minimum: 1.0 title: Limit description: Page size limit default: 50 name: limit in: query - description: Page offset required: false schema: type: integer minimum: 0.0 title: Offset description: Page offset default: 0 name: offset in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LimitOffsetPage_MetaCampaign_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - OrchardIdentityId: [] - OrchardProfileId: [] post: tags: - meta summary: Create Campaign operationId: createMetaCampaign requestBody: content: application/json: schema: $ref: '#/components/schemas/MetaCampaignInput' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaign' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /campaigns: get: tags: - campaigns summary: Search Campaigns operationId: searchCampaigns parameters: - description: Label id required: false schema: type: integer title: Vendorid description: Label id name: vendorId in: query - description: Label subaccount id required: false schema: type: integer title: Subaccountid description: Label subaccount id name: subaccountId in: query - description: Artist ids required: false schema: items: type: string type: array title: Globalparticipantids description: Artist ids name: globalParticipantIds in: query - description: Statuses required: false schema: items: $ref: '#/components/schemas/CampaignStatus' type: array description: Statuses name: statuses in: query - description: Objectives required: false schema: items: $ref: '#/components/schemas/CampaignObjective' type: array description: Objectives name: objectives in: query - description: Platforms required: false schema: items: $ref: '#/components/schemas/CampaignPlatform' type: array description: Platforms name: platforms in: query - description: A search term required: false schema: type: string title: Search description: A search term name: search in: query - description: Order by field(s) required: false schema: type: string title: Orderby description: Order by field(s) default: createdAt.desc name: orderBy in: query - description: Page size limit required: false schema: type: integer maximum: 100.0 minimum: 1.0 title: Limit description: Page size limit default: 50 name: limit in: query - description: Page offset required: false schema: type: integer minimum: 0.0 title: Offset description: Page offset default: 0 name: offset in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LimitOffsetPage_Campaign_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /facebook/connection: get: tags: - facebook summary: Get Facebook Connection Status operationId: getFacebookConnectionStatus responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FacebookConnection' security: - OrchardIdentityId: [] post: tags: - facebook summary: Connect Facebook User operationId: connectFacebookUser requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectFacebookUserInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FacebookConnection' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] delete: tags: - facebook summary: Disconnect Facebook User operationId: disconnectFacebookUser responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FacebookConnection' security: - OrchardIdentityId: [] /facebook/connection/pages: get: tags: - facebook summary: Get Facebook User Pages operationId: getFacebookUserPages responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/FacebookPage' type: array title: Response Getfacebookuserpages security: - OrchardIdentityId: [] - OrchardProfileId: [] /facebook/pages: get: tags: - facebook summary: Get Facebook User Pages For Label description: Returns Facebook Pages shared with the given Label by the User or their colleagues operationId: getFacebookUserPagesForLabel parameters: - required: true schema: type: integer title: Vendorid name: vendorId in: query - required: false schema: type: integer title: Subaccountid name: subaccountId in: query responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/FacebookPage' type: array title: Response Getfacebookuserpagesforlabel '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /facebook/pages/{pageId}: get: tags: - facebook summary: Get Facebook User Page For Label operationId: getFacebookUserPageForLabel parameters: - required: true schema: type: string title: Pageid name: pageId in: path - required: true schema: type: integer title: Vendorid name: vendorId in: query - required: false schema: type: integer title: Subaccountid name: subaccountId in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FacebookPage' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /facebook/pages/{pageId}/instagram/account: get: tags: - facebook summary: Get Instagram Account For Facebook Page operationId: getInstagramAccountForFacebookPage parameters: - required: true schema: type: string title: Pageid name: pageId in: path - required: true schema: type: integer title: Vendorid name: vendorId in: query - required: false schema: type: integer title: Subaccountid name: subaccountId in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InstagramAccountResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /facebook/geolocations: get: tags: - facebook summary: Get Facebook Geolocations operationId: getFacebookTargetingGeolocations parameters: - description: A search term required: true schema: type: string minLength: 3 title: Search description: A search term name: search in: query - description: Max number of results returned required: false schema: type: integer maximum: 500.0 title: Limit description: Max number of results returned default: 25 name: limit in: query responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/FacebookTargetingGeolocation' type: array title: Response Getfacebooktargetinggeolocations '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /facebook/interests: get: tags: - facebook summary: Get Facebook Interests operationId: getFacebookTargetingInterests parameters: - description: A search term required: true schema: type: string minLength: 3 title: Search description: A search term name: search in: query - description: Max number of results returned required: false schema: type: integer maximum: 500.0 title: Limit description: Max number of results returned default: 25 name: limit in: query responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/FacebookTargetingInterest' type: array title: Response Getfacebooktargetinginterests '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /meta/campaigns/{campaignId}: get: tags: - meta summary: Get Campaign Overview operationId: getMetaCampaignOverview parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignOverview' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] put: tags: - meta summary: Update Campaign operationId: updateMetaCampaign parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/MetaCampaignInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaign' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/schedule-and-budget: put: tags: - meta summary: Update Campaign Schedule And Budget operationId: updateMetaCampaignScheduleAndBudget parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/MetaCampaignScheduleAndBudgetInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaign' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/creative: put: tags: - meta summary: Update Campaign Creative operationId: updateMetaCampaignCreative parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/MetaCampaignCreativeInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaign' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/audiences: get: tags: - meta summary: Get Campaign Audiences operationId: getMetaCampaignAudiences parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignAudiences' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/targeting-audience: post: tags: - meta summary: Create Or Update Campaign Targeting Audience operationId: createOrUpdateMetaCampaignTargetingAudience parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/MetaTargetingAudienceInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaTargetingAudience' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/images: get: tags: - meta summary: Get Campaign Images operationId: getMetaCampaignImages parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/MetaCampaignImage' type: array title: Response Getmetacampaignimages '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - OrchardIdentityId: [] - OrchardProfileId: [] post: tags: - meta summary: Create Campaign Image operationId: createMetaCampaignImage parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMetaImageInput' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignImageCredentials' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/images/{imageId}: get: tags: - meta summary: Get Campaign Image operationId: getMetaCampaignImage parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path - required: true schema: type: string title: Imageid name: imageId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignImage' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] delete: tags: - meta summary: Delete Campaign Image operationId: deleteMetaCampaignImage parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path - required: true schema: type: string title: Imageid name: imageId in: path responses: '204': description: Successful Response '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/videos: get: tags: - meta summary: Get Campaign Videos operationId: getMetaCampaignVideos parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/MetaCampaignVideo' type: array title: Response Getmetacampaignvideos '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - OrchardIdentityId: [] - OrchardProfileId: [] post: tags: - meta summary: Create Campaign Video operationId: createMetaCampaignVideo parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMetaVideoInput' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignVideoCredentials' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/videos/{videoId}: get: tags: - meta summary: Get Campaign Video operationId: getMetaCampaignVideo parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path - required: true schema: type: string title: Videoid name: videoId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignVideo' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] delete: tags: - meta summary: Delete Campaign Video operationId: deleteMetaCampaignVideo parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path - required: true schema: type: string title: Videoid name: videoId in: path responses: '204': description: Successful Response '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/adformats: get: tags: - meta summary: Get Campaign Ad Formats operationId: getMetaCampaignAdFormats parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path - description: Campaign content type required: true schema: allOf: - $ref: '#/components/schemas/CampaignContentType' description: Campaign content type name: contentType in: query - description: Campaign platform required: true schema: allOf: - $ref: '#/components/schemas/CampaignPlatformSelector' description: Campaign platform name: platform in: query responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/MetaCampaignAdFormat' type: array title: Response Getmetacampaignadformats '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/adpreview: get: tags: - meta summary: Get Campaign Ad Preview operationId: getMetaCampaignAdPreview parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path - description: Campaign content type required: true schema: allOf: - $ref: '#/components/schemas/CampaignContentType' description: Campaign content type name: contentType in: query - required: true schema: type: string title: Adformatid name: adFormatId in: query - required: false schema: type: string title: Postexternalid name: postExternalId in: query - required: false schema: type: string title: Primarytext name: primaryText in: query - required: false schema: type: string title: Headline name: headline in: query - required: false schema: type: string title: Description name: description in: query - required: false schema: type: string title: Websiteurl name: websiteUrl in: query - description: Campaign call to action type required: false schema: allOf: - $ref: '#/components/schemas/CampaignCallToAction' description: Campaign call to action type name: callToAction in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignAdPreview' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/audience-summary: post: tags: - meta summary: Get Campaign Audience Summary operationId: getMetaCampaignAudienceSummary parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/MetaAudienceSummaryInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignAudienceSummary' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/posts: get: tags: - meta summary: Get Meta campaign available posts for selection operationId: getMetaCampaignPosts parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/MetaCampaignPost' type: array title: Response Getmetacampaignposts '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/post: get: tags: - meta summary: Get Meta campaign current post operationId: getMetaCampaignPost parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignPostResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/images/{imageId}/adimage: put: tags: - meta - internal summary: Refresh Campaign Ad Image operationId: refreshMetaCampaignAdImage parameters: - required: true schema: type: string title: Imageid name: imageId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignImage' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - meta - internal summary: Create Campaign Ad Image operationId: createMetaCampaignAdImage parameters: - required: true schema: type: string title: Imageid name: imageId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMetaAdImageInput' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignImage' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /meta/campaigns/videos/{videoId}/advideo: put: tags: - meta - internal summary: Refresh Campaign Ad Video operationId: refreshMetaCampaignAdVideo parameters: - required: true schema: type: string title: Videoid name: videoId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignVideo' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - meta - internal summary: Create Campaign Ad Video operationId: createMetaCampaignAdVideo parameters: - required: true schema: type: string title: Videoid name: videoId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMetaAdVideoInput' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignVideo' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /meta/campaigns/{campaignId}/engagement-audience-events: get: tags: - meta summary: Get Campaign Engagement Audience Events operationId: getMetaCampaignEngagementAudienceEvents parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/MetaEngagementAudienceEvent' type: array title: Response Getmetacampaignengagementaudienceevents '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/engagement-audience: post: tags: - meta summary: Create Campaign Engagement Audience operationId: createMetaCampaignEngagementAudience parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMetaCampaignEngagementAudienceInput' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaCampaignEngagementAudience' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] /meta/campaigns/{campaignId}/submit: post: tags: - meta summary: Submit Campaign operationId: submitMetaCampaign parameters: - required: true schema: type: string title: Campaignid name: campaignId in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetaAdCampaign' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OrchardIdentityId: [] - OrchardProfileId: [] components: schemas: AdFormatGroup: type: string enum: - FEED - STORY - OTHER title: AdFormatGroup description: An enumeration. Artist: properties: id: type: string title: Id type: object required: - id title: Artist Asset: properties: id: type: string title: Id status: $ref: '#/components/schemas/AssetStatus' filename: type: string title: Filename url: type: string title: Url nullable: true thumbnailUrl: type: string title: Thumbnailurl nullable: true size: type: integer title: Size nullable: true filetype: type: string title: Filetype nullable: true contentType: type: string title: Contenttype nullable: true errors: items: $ref: '#/components/schemas/AssetError' type: array title: Errors nullable: true meta: type: object title: Meta createdAt: type: string format: date-time title: Createdat updatedAt: type: string format: date-time title: Updatedat uploadedAt: type: string format: date-time title: Uploadedat nullable: true type: object required: - id - status - filename - meta - createdAt - updatedAt title: Asset AssetError: properties: actual: type: string title: Actual code: type: string title: Code expected: items: type: string type: array title: Expected type: object required: - actual - code - expected title: AssetError AssetPositionGroup: type: string enum: - RATIO_1_1 - RATIO_9_16 title: AssetPositionGroup description: An enumeration. AssetStatus: type: string enum: - PENDING - PROCESSING - PROCESSING_ERROR - PROCESSING_TIMEOUT - INVALID - COMPLETED title: AssetStatus description: An enumeration. AssetUploadCredentials: properties: assetId: type: string title: Assetid uploadBucket: type: string title: Uploadbucket uploadKey: type: string title: Uploadkey uploadRegion: type: string title: Uploadregion accessKeyId: type: string title: Accesskeyid secretAccessKey: type: string title: Secretaccesskey sessionToken: type: string title: Sessiontoken expiration: type: string format: date-time title: Expiration uploadMetadata: type: object title: Uploadmetadata type: object required: - assetId - uploadBucket - uploadKey - uploadRegion - accessKeyId - secretAccessKey - sessionToken - expiration title: AssetUploadCredentials AudienceGenderSelector: type: string enum: - MALE - FEMALE - ALL title: AudienceGenderSelector description: An enumeration. Campaign: properties: id: type: string title: Id name: type: string title: Name vendorId: type: integer title: Vendorid subaccountId: type: integer title: Subaccountid globalParticipantId: type: string title: Globalparticipantid status: $ref: '#/components/schemas/CampaignStatus' startTime: type: string format: date-time title: Starttime nullable: true endTime: type: string format: date-time title: Endtime nullable: true lifetimeBudget: type: number title: Lifetimebudget nullable: true objective: $ref: '#/components/schemas/CampaignObjective' platforms: items: $ref: '#/components/schemas/CampaignPlatform' type: array createdAt: type: string format: date-time title: Createdat createdBy: type: string title: Createdby updatedAt: type: string format: date-time title: Updatedat updatedBy: type: string title: Updatedby type: object required: - id - name - vendorId - subaccountId - globalParticipantId - status - objective - platforms - createdAt - createdBy - updatedAt - updatedBy title: Campaign CampaignCallToAction: type: string enum: - LEARN_MORE - ORDER_NOW - SHOP_NOW - LISTEN_NOW - WATCH_MORE title: CampaignCallToAction description: An enumeration. CampaignContentType: type: string enum: - IMAGE - VIDEO - POST title: CampaignContentType description: An enumeration. CampaignLinkType: type: string enum: - WEBSITE - LANDING_PAGE title: CampaignLinkType description: An enumeration. CampaignObjective: type: string enum: - AWARENESS - ENGAGEMENT - TRAFFIC title: CampaignObjective description: An enumeration. CampaignPlatform: type: string enum: - FACEBOOK - INSTAGRAM title: CampaignPlatform description: An enumeration. CampaignPlatformSelector: type: string enum: - FACEBOOK - INSTAGRAM - BOTH title: CampaignPlatformSelector description: An enumeration. CampaignStatus: type: string enum: - DRAFT - SUBMITTED - REJECTED - ACTIVE - LIVE title: CampaignStatus description: An enumeration. CampaignSummaryId: type: string enum: - BASICS - SCHEDULE_AND_BUDGET - CREATIVE - AUDIENCE title: CampaignSummaryId description: An enumeration. ConnectFacebookUserInput: properties: userId: type: string title: Userid accessToken: type: string title: Accesstoken type: object required: - userId - accessToken title: ConnectFacebookUserInput CreateMetaAdImageInput: properties: url: type: string maxLength: 2083 minLength: 1 format: uri title: Url type: object required: - url title: CreateMetaAdImageInput CreateMetaAdVideoInput: properties: url: type: string maxLength: 2083 minLength: 1 format: uri title: Url type: object required: - url title: CreateMetaAdVideoInput CreateMetaCampaignEngagementAudienceInput: properties: eventIds: items: type: string type: array minItems: 1 title: Eventids type: object required: - eventIds title: CreateMetaCampaignEngagementAudienceInput CreateMetaImageInput: properties: filename: type: string maxLength: 256 pattern: ^[^/*?]+$ title: Filename example: asset.jpg embed: true positionGroup: $ref: '#/components/schemas/AssetPositionGroup' type: object required: - filename - positionGroup title: CreateMetaImageInput CreateMetaVideoInput: properties: filename: type: string maxLength: 256 pattern: ^[^/*?]+$ title: Filename example: asset.jpg embed: true positionGroup: $ref: '#/components/schemas/AssetPositionGroup' type: object required: - filename - positionGroup title: CreateMetaVideoInput Error: properties: code: type: string title: Code message: type: string title: Message type: object required: - code - message title: Error FacebookConnection: properties: user: anyOf: - $ref: '#/components/schemas/FacebookUser' title: FacebookUser nullable: true status: $ref: '#/components/schemas/FacebookConnectionStatus' scopes: items: type: string type: array title: Scopes requiredScopes: items: type: string type: array title: Requiredscopes type: object required: - status - scopes - requiredScopes title: FacebookConnection FacebookConnectionStatus: type: string enum: - NOT_CONNECTED - SCOPES_MISSING - NO_PAGES - INVALID - CONNECTED title: FacebookConnectionStatus description: An enumeration. FacebookPage: properties: id: type: string title: Id externalId: type: string title: Externalid name: type: string title: Name isManageable: type: boolean title: Ismanageable isValid: type: boolean title: Isvalid pictureUrl: type: string title: Pictureurl nullable: true type: object required: - id - externalId - name - isManageable - isValid title: FacebookPage FacebookTargetingGeolocation: properties: key: type: string title: Key name: type: string title: Name type: type: string title: Type countryCode: type: string title: Countrycode nullable: true countryName: type: string title: Countryname nullable: true region: type: string title: Region nullable: true type: object required: - key - name - type title: FacebookTargetingGeolocation FacebookTargetingInterest: properties: id: type: string title: Id name: type: string title: Name path: items: type: string type: array title: Path disambiguationCategory: type: string title: Disambiguationcategory nullable: true topic: type: string title: Topic nullable: true type: object required: - id - name - path title: FacebookTargetingInterest FacebookUser: properties: name: type: string title: Name picture: type: string title: Picture nullable: true grantedScopes: items: type: string type: array title: Grantedscopes type: object required: - name - grantedScopes title: FacebookUser HTTPValidationError: title: HTTPValidationError type: object properties: message: title: Message type: string code: title: Error code type: string fields: title: Field errors type: object additionalProperties: $ref: '#/components/schemas/FieldError' required: - message - code - fields example: message: Validation error code: validation_error fields: name: message: Cannot be blank code: value_error.required email: message: Not valid email code: value_error.invalid HelloResponse: properties: status: type: string title: Status default: ok type: object title: HelloResponse InstagramAccount: properties: id: type: string title: Id name: type: string title: Name nullable: true username: type: string title: Username profilePictureUrl: type: string title: Profilepictureurl nullable: true type: object required: - id - username title: InstagramAccount InstagramAccountResponse: properties: instagramAccount: anyOf: - $ref: '#/components/schemas/InstagramAccount' title: InstagramAccount nullable: true type: object title: InstagramAccountResponse LimitOffsetPage_Campaign_: properties: total: type: integer title: Total items: items: $ref: '#/components/schemas/Campaign' type: array title: Items limit: type: integer title: Limit offset: type: integer title: Offset type: object required: - total - items - limit - offset title: LimitOffsetPage[Campaign] LimitOffsetPage_MetaCampaign_: properties: total: type: integer title: Total items: items: $ref: '#/components/schemas/MetaCampaign' type: array title: Items limit: type: integer title: Limit offset: type: integer title: Offset type: object required: - total - items - limit - offset title: LimitOffsetPage[MetaCampaign] MetaAdCampaign: properties: status: $ref: '#/components/schemas/CampaignStatus' type: object required: - status title: MetaAdCampaign MetaAudienceSummaryInput: properties: locations: items: $ref: '#/components/schemas/FacebookTargetingGeolocation' type: array title: Locations nullable: true interests: items: $ref: '#/components/schemas/FacebookTargetingInterest' type: array title: Interests nullable: true gender: anyOf: - $ref: '#/components/schemas/AudienceGenderSelector' nullable: true ageMin: type: integer title: Agemin nullable: true ageMax: type: integer title: Agemax nullable: true type: object title: MetaAudienceSummaryInput MetaCampaign: properties: id: type: string title: Id name: type: string title: Name vendorId: type: integer title: Vendorid subaccountId: type: integer title: Subaccountid globalParticipantId: type: string title: Globalparticipantid productId: type: integer title: Productid nullable: true productUpc: type: string title: Productupc nullable: true status: $ref: '#/components/schemas/CampaignStatus' facebookPageId: type: string title: Facebookpageid instagramAccountId: type: string title: Instagramaccountid nullable: true postExternalId: type: string title: Postexternalid nullable: true startTime: type: string format: date-time title: Starttime nullable: true endTime: type: string format: date-time title: Endtime nullable: true lifetimeBudget: type: number title: Lifetimebudget nullable: true contentType: $ref: '#/components/schemas/CampaignContentType' objective: $ref: '#/components/schemas/CampaignObjective' platforms: items: $ref: '#/components/schemas/CampaignPlatform' type: array primaryText: type: string title: Primarytext nullable: true headline: type: string title: Headline nullable: true description: type: string title: Description nullable: true linkType: anyOf: - $ref: '#/components/schemas/CampaignLinkType' nullable: true websiteUrl: type: string title: Websiteurl nullable: true landingPagePath: type: string title: Landingpagepath description: Songwhip landing page path nullable: true landingPageProductId: type: integer title: Landingpageproductid description: Songwhip landing page product Id nullable: true callToAction: anyOf: - $ref: '#/components/schemas/CampaignCallToAction' nullable: true createdAt: type: string format: date-time title: Createdat createdBy: type: string title: Createdby updatedAt: type: string format: date-time title: Updatedat updatedBy: type: string title: Updatedby images: items: $ref: '#/components/schemas/MetaCampaignImage' type: array title: Images videos: items: $ref: '#/components/schemas/MetaCampaignVideo' type: array title: Videos type: object required: - id - name - vendorId - subaccountId - globalParticipantId - status - facebookPageId - contentType - objective - platforms - createdAt - createdBy - updatedAt - updatedBy - images - videos title: MetaCampaign MetaCampaignAdFormat: properties: id: type: string title: Id name: type: string title: Name group: $ref: '#/components/schemas/AdFormatGroup' platform: $ref: '#/components/schemas/CampaignPlatformSelector' type: object required: - id - name - group - platform title: MetaCampaignAdFormat MetaCampaignAdPreview: properties: body: type: string title: Body src: type: string title: Src height: type: integer title: Height width: type: integer title: Width type: object required: - body - src - height - width title: MetaCampaignAdPreview MetaCampaignAudienceSummary: properties: usersLowerBound: type: integer title: Userslowerbound usersUpperBound: type: integer title: Usersupperbound estimateReady: type: boolean title: Estimateready type: object required: - usersLowerBound - usersUpperBound - estimateReady title: MetaCampaignAudienceSummary MetaCampaignAudiences: properties: targetingAudience: anyOf: - $ref: '#/components/schemas/MetaTargetingAudience' title: MetaTargetingAudience nullable: true type: object title: MetaCampaignAudiences MetaCampaignCreativeInput: properties: contentType: $ref: '#/components/schemas/CampaignContentType' platform: $ref: '#/components/schemas/CampaignPlatformSelector' postExternalId: type: string title: Postexternalid nullable: true primaryText: type: string title: Primarytext nullable: true headline: type: string title: Headline nullable: true description: type: string title: Description nullable: true linkType: $ref: '#/components/schemas/CampaignLinkType' websiteUrl: type: string maxLength: 65536 minLength: 1 format: uri title: Websiteurl nullable: true landingPagePath: type: string title: Landingpagepath description: Songwhip landing page path nullable: true landingPageProductId: type: integer title: Landingpageproductid description: Songwhip landing page product Id nullable: true callToAction: $ref: '#/components/schemas/CampaignCallToAction' type: object required: - contentType - platform - linkType - callToAction title: MetaCampaignCreativeInput MetaCampaignEngagementAudience: properties: id: type: string title: Id lowerBound: type: integer title: Lowerbound upperBound: type: integer title: Upperbound eventIds: items: type: string type: array title: Eventids type: object required: - id - lowerBound - upperBound - eventIds title: MetaCampaignEngagementAudience MetaCampaignError: properties: field: type: string title: Field code: type: string title: Code message: type: string title: Message type: object required: - field - code - message title: MetaCampaignError MetaCampaignImage: properties: id: type: string title: Id assetId: type: string title: Assetid positionGroup: $ref: '#/components/schemas/AssetPositionGroup' filename: type: string title: Filename url: type: string title: Url nullable: true thumbnailUrl: type: string title: Thumbnailurl nullable: true size: type: integer title: Size nullable: true status: $ref: '#/components/schemas/AssetStatus' errors: items: $ref: '#/components/schemas/AssetError' type: array title: Errors createdAt: type: string format: date-time title: Createdat updatedAt: type: string format: date-time title: Updatedat uploadedAt: type: string format: date-time title: Uploadedat nullable: true type: object required: - id - assetId - positionGroup - filename - status - createdAt - updatedAt title: MetaCampaignImage MetaCampaignImageCredentials: properties: imageId: type: string title: Imageid credentials: $ref: '#/components/schemas/AssetUploadCredentials' type: object required: - imageId - credentials title: MetaCampaignImageCredentials MetaCampaignInput: properties: name: type: string title: Name vendorId: type: integer title: Vendorid subaccountId: type: integer title: Subaccountid nullable: true globalParticipantId: type: string title: Globalparticipantid productId: type: integer title: Productid nullable: true facebookPageId: type: string title: Facebookpageid objective: $ref: '#/components/schemas/CampaignObjective' type: object required: - name - vendorId - globalParticipantId - facebookPageId - objective title: MetaCampaignInput MetaCampaignOverview: properties: campaign: $ref: '#/components/schemas/MetaCampaign' summary: items: $ref: '#/components/schemas/MetaCampaignSummary' type: array title: Summary type: object required: - campaign - summary title: MetaCampaignOverview MetaCampaignPost: properties: id: type: string title: Id platform: $ref: '#/components/schemas/CampaignPlatform' type: type: string title: Type title: type: string title: Title nullable: true permalinkUrl: type: string title: Permalinkurl pictureUrl: type: string title: Pictureurl nullable: true thumbnailUrl: type: string title: Thumbnailurl nullable: true createdAt: type: string format: date-time title: Createdat type: object required: - id - platform - type - permalinkUrl - createdAt title: MetaCampaignPost MetaCampaignPostResponse: properties: post: anyOf: - $ref: '#/components/schemas/MetaCampaignPost' title: MetaCampaignPost nullable: true type: object title: MetaCampaignPostResponse MetaCampaignScheduleAndBudgetInput: properties: startTime: type: string format: date-time title: Starttime endTime: type: string format: date-time title: Endtime lifetimeBudget: type: number exclusiveMinimum: 0.0 title: Lifetimebudget type: object required: - startTime - endTime - lifetimeBudget title: MetaCampaignScheduleAndBudgetInput MetaCampaignSummary: properties: id: $ref: '#/components/schemas/CampaignSummaryId' errors: items: $ref: '#/components/schemas/MetaCampaignError' type: array title: Errors type: object required: - id - errors title: MetaCampaignSummary MetaCampaignVideo: properties: id: type: string title: Id assetId: type: string title: Assetid positionGroup: $ref: '#/components/schemas/AssetPositionGroup' filename: type: string title: Filename url: type: string title: Url nullable: true thumbnailUrl: type: string title: Thumbnailurl nullable: true size: type: integer title: Size nullable: true status: $ref: '#/components/schemas/AssetStatus' errors: items: $ref: '#/components/schemas/AssetError' type: array title: Errors createdAt: type: string format: date-time title: Createdat updatedAt: type: string format: date-time title: Updatedat uploadedAt: type: string format: date-time title: Uploadedat nullable: true type: object required: - id - assetId - positionGroup - filename - status - createdAt - updatedAt title: MetaCampaignVideo MetaCampaignVideoCredentials: properties: videoId: type: string title: Videoid credentials: $ref: '#/components/schemas/AssetUploadCredentials' type: object required: - videoId - credentials title: MetaCampaignVideoCredentials MetaEngagementAudienceEvent: properties: id: type: string title: Id name: type: string title: Name platform: $ref: '#/components/schemas/CampaignPlatform' type: object required: - id - name - platform title: MetaEngagementAudienceEvent MetaTargetingAudience: properties: id: type: string title: Id locations: items: $ref: '#/components/schemas/FacebookTargetingGeolocation' type: array title: Locations ageMin: type: integer title: Agemin ageMax: type: integer title: Agemax gender: $ref: '#/components/schemas/AudienceGenderSelector' interests: items: $ref: '#/components/schemas/FacebookTargetingInterest' type: array title: Interests createdAt: type: string format: date-time title: Createdat updatedAt: type: string format: date-time title: Updatedat type: object required: - id - locations - ageMin - ageMax - gender - interests - createdAt - updatedAt title: MetaTargetingAudience MetaTargetingAudienceInput: properties: locations: items: $ref: '#/components/schemas/FacebookTargetingGeolocation' type: array minItems: 1 title: Locations ageMin: type: integer minimum: 13.0 title: Agemin default: 18 ageMax: type: integer maximum: 65.0 title: Agemax gender: $ref: '#/components/schemas/AudienceGenderSelector' interests: items: $ref: '#/components/schemas/FacebookTargetingInterest' type: array title: Interests type: object required: - locations - ageMax - gender - interests title: MetaTargetingAudienceInput UpdateAssetInput: properties: status: anyOf: - $ref: '#/components/schemas/AssetStatus' nullable: true size: type: integer title: Size nullable: true filetype: type: string title: Filetype nullable: true contentType: type: string title: Contenttype nullable: true meta: type: object title: Meta nullable: true errors: items: $ref: '#/components/schemas/AssetError' type: array title: Errors nullable: true uploadedAt: type: string format: date-time title: Uploadedat nullable: true type: object title: UpdateAssetInput FieldError: title: FieldError type: object properties: message: title: Message type: string code: title: Error code type: string required: - message - code securitySchemes: OrchardIdentityId: type: apiKey in: header name: Orchard-Identity-Id OrchardProfileId: type: apiKey in: header name: Orchard-Profile-Id