Notes<\/p> Attachments: type: - string - 'null' description: Attachments format: URI maxLength: 1024 default: null examples: - https://twc-attachments.s3.us-west-1.amazonaws.com/image.png PaymentId: type: - integer - 'null' description: Payment Id format: int32 default: null examples: - null CampaignsAdditionalRequirementsId: type: - integer - 'null' description: Campaigns Additional Requirements Id format: int32 default: null examples: - null IsPublisherNotified: type: integer description: Is Publisher Notified flag default: 0 examples: - 0 PaymentTerm: type: - integer - 'null' description: Payment Term default: null examples: - null PaymentDueDate: type: - string - 'null' description: Payment Due Date format: date-time default: null examples: - null Instructions: type: string description: Instructions default: '' examples: -
example
PurchaseOrderId: type: - string - 'null' description: Purchase Order Id maxLength: 32 default: null examples: - null Title: type: - string - 'null' description: Title default: null examples: - null PaymentStatus: type: - string - 'null' description: Payment Status default: null examples: - null PaymentErrorMessage: type: - string - 'null' description: Payment Error Message default: null examples: - null PaymentStatusDate: type: - string - 'null' description: Payment Status Date default: null examples: - null PaymentRejectionNote: type: - string - 'null' description: Payment Rejection Note default: null examples: - null required: - Id - PublisherId - CampaignId - ReqType required: - type - href - PublishersAdditionalRequirements CampaignModel: type: object properties: type: type: string description: Type of entity examples: - Campaign href: type: string description: CreatorIQ API URL to get campaign information examples: - https://apis.creatoriq.com/crm/v1/api/campaign/79706 Campaign: type: object description: Campaign information properties: CampaignId: type: integer description: Unique campaign id minimum: 1 examples: - 42066 LogoURL: type: - string - 'null' description: Campaign logo url examples: - https://social-pictures-storage.s3.amazonaws.com/thumb_8ae2886610f22790ad4e2d9c852c6dea_5522569.jpeg?time=1671469163 IsSale: type: integer enum: - 0 - 1 default: 0 NetworkId: type: integer description: Id of partner examples: - 21 AdvertiserId: type: integer description: ID of the custom brand (advertiser) associated with this campaign. This value corresponds to `Brand.BrandId` from `GET /crm/v1/api/brands`. examples: - 6451 CampaignName: type: string description: Campaign name examples: - Coca-Cola Description: type: - string - 'null' description: Campaign description examples: - Lorem ipsum SalesPerson: type: - string - 'null' examples: - Neo Manager: type: - string - 'null' description: Name of manager campaign examples: - Alex ExpectedCloseDate: type: - string - 'null' description: Expected close date campaign default: null CID: type: - string - 'null' default: null x-deprecated: true OfferId: type: - string - 'null' description: Unique offer id. Related with OfferURL default: null SubId: type: - string - 'null' default: null x-deprecated: true x-remove-response: true OfferURL: type: - string - 'null' description: The URL provided by the client to be tracked in the campaign format: uri examples: - https://google.com HashTag: type: - string - 'null' description: Hashtags and keywords you tracked for this campaign examples: - USWNT,#TeamNike,Nike,MLS CRMOpportunityState: type: - string - 'null' default: null x-deprecated: true x-remove-response: true CRMPipeline: type: - string - 'null' default: null x-deprecated: true x-remove-response: true CRMPipelineStage: type: - string - 'null' default: null x-deprecated: true x-remove-response: true CampaignStatus: type: - string - 'null' description: Current status of campaign. examples: - Closed StartDate: type: string description: Campaign start date examples: - '2022-07-01' EndDate: type: string description: Campaign end date examples: - '2022-09-01' Visibility: type: string enum: - By invitation only - Open to eligible influencers - Open to all publishers - null description: Visibility status for publisher examples: - By invitation only Approval: type: - string - 'null' default: null Direct: type: integer enum: - 0 - 1 examples: - 1 AdvertisingPartner: type: - string - 'null' description: Advertising partner name default: null Probability: type: - number - 'null' description: The probability that a talent or publisher will join the network default: null x-deprecated: true TermsAndConditions: type: - string - 'null' description: Terms and conditions url default: null x-deprecated: true ApproveTermsAndConditions: type: integer enum: - 0 - 1 - null description: Flag represents if terms and condition approved. x-deprecated: true TotalBudget: type: - number - 'null' description: Total budget for campaign default: null examples: - 100 TotalBudgetFromAdvertiser: type: - number - 'null' description: Initial Brand Offering Amount default: null examples: - 120 MaxWeeklyBudget: type: - number - 'null' description: Max weekly budget default: null examples: - 2200 MaxMonthlyBudget: type: - number - 'null' description: Max monthly budget default: null examples: - 300 SpentToDate: type: - number - 'null' default: null Objective: type: - string - 'null' examples: - Drive product sales Format: type: - string - 'null' examples: - Giveaway CreatedBy: type: - string - 'null' description: Name of the person who create campaign examples: - manager DateTimeCreated: type: string description: Created date of campaign format: date examples: - '2015-01-29' ActivatedBy: type: - string - 'null' description: Name of the person who activated campaign examples: - Admin x-deprecated: true ActivationDate: type: - string - 'null' description: Activation date and time default: null x-deprecated: true LastModified: type: - string - 'null' description: Last modified date and time examples: - '2022-08-03 08:25:00' LastModifiedBy: type: - string - 'null' description: Name of the person who made the last changes examples: - Admin InstructionsForPublishers: type: - string - 'null' description: General instructions for publishers examples: - Launch 3 posts ContestsForPublishers: type: - string - 'null' default: null x-deprecated: true PlatformWeb: type: integer enum: - 0 - 1 - null description: '* 0 or null represents Web is disabled for campaign * 1 represents Web is enabled for campaign ' PlatformYouTube: type: integer enum: - 0 - 1 - null description: '* 0 or null represents YouTube is disabled for campaign * 1 represents YouTube is enabled for campaign ' PlatformFacebook: type: integer enum: - 0 - 1 - null description: '* 0 or null represents Facebook disabled * 1 represents Facebook enabled for campaign ' PlatformInstagram: type: integer enum: - 0 - 1 - null description: '* 0 or null represents Instagram disabled * 1 represents Instagram enabled for campaign ' PlatformTumblr: type: integer enum: - 0 - 1 - null description: '* 0 or null represents Tumblr disabled * 1 represents Tumblr enabled for campaign ' PlatformTwitter: type: integer enum: - 0 - 1 - null description: '* 0 or null represents Twitter disabled * 1 represents Twitter enabled for campaign ' RequiredPostsYouTube: type: - integer - 'null' description: Required posts count on Youtube if Youtube enabled examples: - 2 RequiredPostsFacebook: type: - integer - 'null' description: Required posts count on Facebook if Facebook enabled examples: - 2 RequiredPostsTwitter: type: - integer - 'null' description: Required posts count on Twitter if Twitter enabled examples: - 3 RequiredPostsInstagram: type: - integer - 'null' description: Required posts count on Instagram if Instagram enabled examples: - 4 RequiredPostsTumblr: type: - integer - 'null' description: Required posts count on Tumblr if Tumblr enabled default: null examples: - 3 InstructionsYouTube: type: - string - 'null' description: Instructions to publisher for Youtube default: null InstructionsYouTubePlaylist: type: - string - 'null' description: Instructions for Youtube playlist default: null InstructionsFacebook: type: - string - 'null' description: Instructions to publisher for Facebook default: null InstructionsTwitter: type: - string - 'null' description: Instructions to publisher for Twitter default: null InstructionsInstagram: type: - string - 'null' description: Instructions to publisher for Instagram default: null InstructionsTumblr: type: - string - 'null' description: Instructions to publisher for Tumblr default: null Benchmarks: type: - string - 'null' description: Aggregated stats in json format for campaign default: null examples: - '{"InfluencersNum":"3","PostsNum":"4","VideosNum":0,"Reach":0,"ExpectedReach":"","Engagement":0,"Impressions":"10000","VideoViews":0,"TotalSocialConnections":"","YoutubeEngagement":0,"EarnedMedia":0}' x-remove-response: true DateLastActivityUpdated: type: - string - 'null' description: Last activity update date examples: - '2020-01-24 10:14:39' PlatformGoogle: type: integer enum: - 0 - 1 - null description: '* 0 or null represents Google disabled * 1 represents Google enabled for campaign ' RequiredPostsGoogle: type: - integer - 'null' description: Required posts count on Google examples: - 4 InstructionsGoogle: type: - string - 'null' description: Instructions to publisher for Google default: null MultipleHashTagsLogic: type: string enum: - AND - OR description: '* AND => all tags must be in post for include to campaign * OR => one of tags must be in post for include to campaign ' examples: - OR LinksForCampaign: type: string description: Links to external docs default: '' examples: - http://google.test.com InstructionsYouTubeTrigger: type: integer enum: - 0 - 1 - null x-remove-response: true InstructionsFacebookTrigger: type: integer enum: - 0 - 1 - null x-remove-response: true InstructionsTwitterTrigger: type: integer enum: - 0 - 1 - null x-remove-response: true InstructionsInstagramTrigger: type: integer enum: - 0 - 1 - null x-remove-response: true InstructionsGoogleTrigger: type: integer enum: - 0 - 1 - null x-remove-response: true Tags: type: - string - 'null' description: Comma separated tags list for campaign examples: - '"Authentication","Brazil","Celebrity Creators"' PlatformVine: type: integer enum: - 0 - 1 - null description: '* 0 or null represents Vine disabled * 1 represents Vine enabled for campaign ' RequiredPostsVine: type: - integer - 'null' description: Number required post for Vine examples: - 3 InstructionsVine: type: - string - 'null' description: Instructions to publisher for Vine platform examples: -2 posts
InstructionsVineTrigger: type: integer enum: - 0 - 1 - null examples: - 1 x-remove-response: true ContentLead: type: - string - 'null' description: Content Lead name examples: - John Doe DateInfluencerProposalDue: type: - string - 'null' default: null x-deprecated: true MediaBudget: type: - number - 'null' description: Media budget for campaign examples: - 1000 ProductionBudget: type: - number - 'null' description: Production budget settings examples: - 12000 CreativeBackground: type: - string - 'null' description: Part of creative brief settings. What is the brand in question all about, and why are they interested in working with network default: null examples: -HTML
CreativeObjective: type: - string - 'null' description: Part of creative brief settings. default: null examples: -objective
CreativeKeyMessage: type: - string - 'null' description: Part of creative brief settings default: null examples: - What is the main message, theme or slogan for the campaign? CreativeTargetMarket: type: - string - 'null' description: Part of creative brief settings.Quantitative (Age/Gender/Geo for both primary and secondary audiences) default: null CreativeInformationConsiderations: type: - string - 'null' description: Part of creative brief settings. default: null CreativeDeliverables: type: - string - 'null' description: Part of creative brief settings.Number of creators needed, etc. default: null CreativeStepsTimings: type: - string - 'null' description: Part of creative brief settings. default: null InfluencerInfluencerOverview: type: - string - 'null' description: Part of creative brief settings. default: null examples: - Spokeswomen, brand ambassador, fashion/beauty bloggers, and brand advocates InfluencerQuantReqs: type: - string - 'null' description: How many creators do we need? examples: - 10k followers on at least one social platform InfluencerAudience: type: - string - 'null' description: Part of creative brief settings.Demographics and audience segmentation examples: - Female, 18 to 45 InfluencerValueProp: type: - string - 'null' examples: -HTML template
InfluencerIndicativeInfluencers: type: - string - 'null' examples: -Creator Brief - Indicative Creators
InfluencerInformation: type: - string - 'null' examples: -Tag @CocaCola
TalentBudget: type: - number - 'null' description: Part of budget settings. default: null MainBenchmarks: type: - string - 'null' description: Aggregated field with settings for campaign. examples: - '{"InfluencersNum": true, "VideosNum": true, "PostsNum": true, "VideoViews": true, "Engagement": true, "Reach": "", "Impressions": "", "ExpectedReach": true}' x-remove-response: true Currency: type: string description: Currency of campaign minLength: 2 maxLength: 5 examples: - USD Paid: type: integer enum: - 0 - 1 x-deprecated: true Contest: type: - string - 'null' default: null PlatformPinterest: type: integer enum: - 0 - 1 - null description: 'Flag represents if Pinteres enabled or disabled * 0 or null Pinterest disabled for Campaign * 1 Pinterest enabled for Campaign ' RequiredPostsPinterest: type: - integer - 'null' description: Count required post for Pinterest default: null examples: - 33 InstructionsPinterest: type: - string - 'null' description: Instructions to publisher for Pinterest default: null InstructionsPinterestTrigger: type: integer enum: - 0 - 1 - null x-remove-response: true PlatformSnapchat: type: integer enum: - 0 - 1 - null description: 'Flag represents if Snapchat enabled or disabled * 0 or null Snapchat disabled for Campaign * 1 Snapchat enabled for Campaign description: Platform Snapchat ' RequiredPostsSnapchat: type: - integer - 'null' description: Required post for Snapchat examples: - 3 InstructionsSnapchat: type: - string - 'null' description: Instructions to publisher for Snapchat default: null InstructionsSnapchatTrigger: type: integer enum: - 0 - 1 - null description: Instructions for Snapchat Trigger x-remove-response: true InstructionsTumblrTrigger: type: integer enum: - 0 - 1 - null description: Instructions for Tumblr Trigger x-remove-response: true RequiredPostsWeb: type: - integer - 'null' description: Required post for web examples: - 4 InstructionsWeb: type: - string - 'null' description: Instructions to publisher for web default: null InstructionsWebTrigger: type: integer enum: - 0 - 1 - null description: Instructions for Web Trigger x-remove-response: true SocialReportMetrics: type: - string - 'null' description: Json object with metrics. Used in UI default: null ProducerFee: type: - number - 'null' default: null examples: - 1095.5 AccountsParticipation: type: string enum: - All - BiggestPerNetwork - null SubmitForApprovalBy: type: - string - 'null' examples: - '2016-07-08' x-deprecated: true PublishAfter: type: - string - 'null' description: Publish posts or content after date this date examples: - '2017-06-01 00:00:00.0000000 +00:00' PublishBefore: type: - string - 'null' description: Publish posts or content before date this date examples: - '2017-09-30 00:00:00.0000000 +00:00' NetworkCampaignID: type: - string - 'null' description: External id of campaign. Can be setuped manually examples: - IO-522558 NetworkCampaignName: type: - string - 'null' description: External campaign name default: null AccessControl: type: - string - 'null' description: Techincal field. Need for access conrtol for campaign default: null x-remove-response: true ThumbLogoUrl: type: - string - 'null' description: Small logo url for campaign examples: - https://socialedge-campaigns.s3.amazonaws.com/thumb_7382.png RequiredPostsMusically: type: - integer - 'null' description: Count required post for Musically minimum: 0 default: null x-deprecated: true InstructionsMusically: type: - string - 'null' description: Instructions to publisher for Musically default: null x-deprecated: true InstructionsMusicallyTrigger: type: - integer - 'null' description: Instructions for Musically Trigger default: null x-deprecated: true PlatformMusically: type: integer enum: - 0 - 1 - null description: 'Flag represents if Musically enabled or disabled * 0 or null Musically disabled for Campaign * 1 Musically enabled for Campaign description ' x-deprecated: true AccountManagerName: type: - string - 'null' description: Account manager name examples: - John Doe Tier: type: - string - 'null' description: Campaign category examples: - CocaCola ContentApproval: type: string enum: - Required - Network approval required - null description: Specify if Campaign need content approval or not examples: - Required SubmitByDate: type: - string - 'null' description: Submit content before date examples: - '2016-01-20 16:00:00.0000000 -08:00' PayoutType: type: string enum: - PerPost - Fixed - null RespondByDate: type: - string - 'null' examples: - '2020-05-28' TravelBudget: type: - number - 'null' examples: - 8000 PostApproval: type: string enum: - Required - Not Required - null description: 'Flag for live post approval. * Required => live post approval enabled * Not Required => live post approval not enabled ' CustomFieldValue1: type: - string - 'null' description: Custom field for partner. Can be changed in admin tool default: null CustomFieldValue2: type: - string - 'null' description: Custom field for partner. Can be changed in admin tool default: null CustomFieldValue3: type: - string - 'null' description: Custom field for partner. Can be changed in admin tool default: null CustomFieldValue4: type: - string - 'null' description: Custom field for partner. Can be changed in admin tool default: null CustomFieldValue5: type: - string - 'null' description: Custom field for partner. Can be changed in admin tool default: null YoutubeEngagementMetric: type: string enum: - Views - Reach - null description: Youtube engagement metric for campaign CanvsData: type: - string - 'null' default: null x-deprecated: true CampaignUpdateFrequency: type: - string - 'null' default: null RequiredPostsJSON: type: - string - 'null' description: Aggregated list which represents RequiredPost fields in JSON format examples: - '{"Facebook":2,"YouTube":2,"Twitter":1,"Instagram":1,"Google":0,"Pinterest":1,"Musically":0,"Tumblr":0,"Snapchat":0,"Web":0,"Twitch":0}' InstructionsJSON: type: - string - 'null' description: Instructions settings on JSON format examples: - '{"FacebookTrigger":"1","GoogleTrigger":"1","InstagramTrigger":"1","TwitterTrigger":"1","VineTrigger":"1","YouTubeTrigger":"1"}' PlatformsJSON: type: - string - 'null' description: Aggregated list which represents settings in JSON format examples: - '{"Facebook":"1","Instagram":"1","Pinterest":"1","Twitter":"1","Web":"1","YouTube":"1"}' ContractRequired: type: integer enum: - 0 - 1 - null description: '* 0 or null contract not required * 1 contract required ' ContractTermsAcceptedAt: type: - string - 'null' description: Contract Terms and Conditions accept date examples: - '2022-02-03' ContractTermsAcceptedBy: type: - string - 'null' description: Contract Terms and Conditions accept person examples: - admin CollaborationVisibility: type: - string - 'null' default: null TrackingLevel: type: string enum: - publisher - post - null TrackingAddUTM: type: integer enum: - 0 - 1 - null description: Add UTM Parameters for tracking links TrackingLinkCreationType: type: string enum: - mass-generate - link-by-link - null PaymentTerm: type: - integer - 'null' default: null BrandKeyword: type: - string - 'null' description: List of brand keywords examples: - null CreatedById: type: - integer - 'null' description: Id of the person who create campaign examples: - 1244 CampaignManagerId: type: - integer - 'null' description: Id of the campaign manager examples: - 123 DivisionId: type: - integer - 'null' description: Division id default: null DateDependenciesUpdated: type: - string - 'null' examples: - '2019-06-14 14:38:32.000' ClosedAt: type: - string - 'null' description: Campaign close date examples: - '2018-03-15 00:54:09.000' ClosedBy: type: - string - 'null' description: Name of the person who close campaign examples: - Admin TrackingType: type: - string - 'null' default: null Targets: type: - object - 'null' properties: Id: type: integer examples: - 123 CampaignId: type: integer examples: - 5425 Gender: type: - string - 'null' examples: - '"Female"' AgeGroup: type: - string - 'null' examples: - '"18-24","25-34","35-44"' Languages: type: - string - 'null' examples: - '"English"' Locations: type: - string - 'null' examples: - '"United Kingdom"' Devices: type: - string - 'null' default: null Browser: type: - string - 'null' default: null LastModifiedBy: type: - string - 'null' description: Name of the person who made the last changes examples: - Admin LastModified: type: - string - 'null' description: Last modified date and time examples: - '2016-06-30 15:51:31' SocialVolume: type: - string - 'null' default: null required: - Id Payout: type: - object - 'null' allOf: - $ref: '#/components/schemas/PayoutModel' PublishersCount: type: - integer - 'null' description: Count of publishers in campaign examples: - 20 CampaignVisibility: type: integer enum: - 0 - 1 description: 'Campaign visibility for publisher. * If 0 Campaign not visible to publisher * If 1 Campaign visible to publisher ' EarnedPostsFlag: type: integer enum: - 0 - 1 - null TikTokOneCampaign: type: integer enum: - 0 - 1 - null description: Indicates whether the campaign is associated with TikTok One. YouTubeBrandConnect: type: integer enum: - 0 - 1 - null description: Indicates whether the campaign is associated with YouTube Brand Connect. YouTubeChannel: type: - string - 'null' description: Indicates YouTube Brand channel associated with campaign. examples: - '@creatorIQOfficial' NextGen: type: string enum: - '0' - '1' - null description: '[Optional] Flag indicating if the campaign is created using the new logic' examples: - '1' BrandId: type: - string - 'null' description: '[Optional] ID of the global brand associated with this campaign. This value corresponds to `brandId` from `GET /crm/v2/api/brands`.' examples: - '12345' BrandAndTerms: type: string description: '[Optional] Collect content that includes both a brand mention and at least one of the specified terms' examples: - Trending DefiniteTerms: type: string description: '[Optional] Collect content that includes any of the specified keywords, even without a brand mention' examples: - Ad NegativeTerm: type: string description: '[Optional] Keywords and hashtags that must not be included in the post' examples: - repost InternalDescription: type: string description: '[Optional] Campaign Description' examples: - Campaign details BrandCollectContent: type: string enum: - '0' - '1' - null description: '[Optional] A flag to indicate if the branded content should be collected' examples: - '1' required: - type - href - Campaign CampaignBodyPostRequirementsModel: type: object properties: SocialNetwork: type: string enum: - Facebook - Instagram - YouTube - Web - Twitter - Twitch - TikTok - Snapchat - Pinterest description: Social Network examples: - Instagram PostType: type: string enum: - Permalink - Story - Image - Reel - Photo - Video - Tweet - TiktokPost - Stream - Other - Article - Status - Blog - Short - Link - Carousel - Clip - Post - Text - Album description: Social Network Post Type examples: - Image Title: type: - string - 'null' description: Custom Requirement Title default: null examples: - Insta Title PostRequirementId: type: string description: Post Requirement Id format: int32 examples: - '2982229' Instructions: type: - string - 'null' description: Requirement Instructions default: null examples: - null required: - SocialNetwork - PostType - Title - PostRequirementId - Instructions campaignBody: type: object description: Campaign request body properties: PostRequirements: type: array description: Post Requirements in Campaign Body items: $ref: '#/components/schemas/CampaignBodyPostRequirementsModel' CampaignName: type: string description: Campaign name examples: - CampaignCola NetworkCampaignName: type: - string - 'null' description: External campaign name examples: - NetworkCampaignCola PlatformYouTube: type: integer enum: - 0 - 1 description: '* If 0 disable Youtube for campaign * If 1 enable Youtube for campaign ' examples: - 0 RequiredPostsYouTube: type: integer description: Required posts count on Youtube format: int32 minimum: 0 examples: - 3 PlatformFacebook: type: integer enum: - 0 - 1 description: '* If 0 disable Facebook for campaign * If 1 enable Facebook for campaign ' RequiredPostsFacebook: type: integer description: Required posts count on Facebook examples: - 3 PlatformTwitter: type: integer enum: - 0 - 1 description: '* If 0 disable Twitter for campaign * If 1 enable Twitter for campaign ' RequiredPostsTwitter: type: integer description: Required posts count on Twitter examples: - 32 PlatformInstagram: type: integer enum: - 0 - 1 description: '* If 0 disable Instagram for campaign * If 1 enable Instagram for campaign ' RequiredPostsInstagram: type: integer description: Required posts count on Instagram examples: - 43 PlatformPinterest: type: integer enum: - 0 - 1 description: Platform Pinterest RequiredPostsPinterest: type: integer description: Required posts count on Pinterest examples: - 33 PlatformTwitch: type: integer enum: - 0 - 1 description: '* If 0 disable Twitch for campaign * If 1 enable Twitch for campaign ' RequiredPostsTwitch: type: integer description: Required posts count on Twitch examples: - 3 PlatformTumblr: type: integer enum: - 0 - 1 description: '* If 0 disable Tumblr for campaign * If 1 enable Tumblr for campaign ' RequiredPostsTumblr: type: integer description: Required posts count on Tumblr examples: - 22 PlatformSnapchat: type: integer enum: - 0 - 1 description: Platform Snapchat RequiredPostsSnapchat: type: integer description: Required posts count on Snapchat examples: - 3 PlatformTikTok: type: integer enum: - 0 - 1 description: '* If 0 disable TikTok for campaign * If 1 enable TikTok for campaign ' RequiredPostsTikTok: type: integer description: Required posts count on TikTok examples: - 2 PlatformLinkedIn: type: integer enum: - 0 - 1 description: '* If 0 disable LinkedIn for campaign * If 1 enable LinkedIn for campaign ' RequiredPostsLinkedIn: type: integer description: Required posts count on LinkedIn examples: - 4 PlatformWeibo: type: integer enum: - 0 - 1 description: '* If 0 disable Weibo for campaign * If 1 enable Weibo for campaign ' RequiredPostsWeibo: type: integer description: Required posts count on Weibo minimum: 0 examples: - 4 PlatformWeb: type: integer enum: - 0 - 1 description: '* If 0 disable Web for campaign * If 1 enable Web for campaign ' RequiredPostsWeb: type: integer description: Required posts count on Web examples: - 3 CampaignStatus: type: - string - 'null' description: Current status of campaign. examples: - Closed StartDate: type: string description: Campaign start date examples: - '2020-03-29' EndDate: type: string description: Campaign end date examples: - '2020-02-29' Description: type: string description: Campaign description examples: - Lorem Ipsum LinksForCampaign: type: string description: Links to external docs default: '' examples: - http://google.test.com Manager: type: string description: Campaign manager name examples: - John Manager AccountManagerName: type: string description: Account manager name examples: - John Doe SalesPerson: type: string description: Sales person nam examples: - admin IsSale: type: integer enum: - 0 - 1 default: 0 Visibility: type: string enum: - By invitation only - Open to eligible influencers - Open to all publishers - null description: Visibility status for publisher examples: - By invitation only FixedFeeTrigger: type: - string - 'null' default: null PayoutType: type: string enum: - PerPost - Fixed - null AdvertiserId: type: integer description: 'ID of a custom brand (advertiser). Get this value from `GET /crm/v1/api/brands`, using the returned `Brand.BrandId`. Do not use this field for a global brand. ' examples: - 1244 BrandId: type: integer description: 'ID of a global brand. Get this value from `GET /crm/v2/api/brands`, using the returned `brandId`. Do not use a `Brand.BrandId` value returned by `GET /crm/v1/api/brands`. ' examples: - 1244 HashTag: type: - string - 'null' description: Hashtags and keywords you tracked for this campaign examples: - USWNT,#TeamNike,Nike,MLS BrandKeyword: type: - string - 'null' description: List of brand keywords examples: - null MultipleHashTagsLogic: type: string enum: - AND - OR description: '* AND => all tags must be in post for include to campaign * OR => one of tags must be in post for include to campaign ' CampaignManagerId: type: - integer - 'null' description: Unique campaign manager id examples: - 123 TikTokOneCampaign: type: integer enum: - 0 - 1 - null description: 'Defines whether to create a TikTok One campaign. * 0 – TikTok One campaign will not be created. * 1 – TikTok One campaign will be created. ' examples: - 1 YouTubeBrandConnect: type: integer enum: - 0 - 1 - null description: 'Defines whether to create a YouTube One campaign. * 0 – TikTok One campaign will not be created. * 1 – TikTok One campaign will be created. ' examples: - 1 YouTubeChannel: type: - string - 'null' description: 'Defines YouTube Brand Connect Brand Channel ' examples: - '@creatoriqOfficial' NextGen: type: - boolean - 'null' description: '[Optional] Flag indicating if the campaign is created using the new logic' examples: - true BrandAndTerms: type: string description: '[Optional] Collect content that includes both a brand mention and at least one of the specified terms' examples: - Trending DefiniteTerms: type: string description: '[Optional] Collect content that includes any of the specified keywords, even without a brand mention' examples: - Ad NegativeTerm: type: string description: '[Optional] Keywords and hashtags that must not be included in the post' examples: - repost InternalDescription: type: string description: '[Optional] Campaign Description' examples: - Campaign details BrandCollectContent: type: - boolean - 'null' description: '[Optional] A flag to indicate if the branded content should be collected' examples: - true required: - CampaignName - StartDate minProperties: 1 CreateAdvertiserBrandSuccessResponseModel: type: object properties: type: const: Brand description: Type of Search href: type: string description: CreatorIQ API URL to get advertiser info examples: - https://apis.creatoriq.com/crm/v1/api/brands/50852 Brand: type: object properties: BrandName: type: string examples: - Super Brand BillingName: type: - string - 'null' examples: - Billing Name Description: type: string examples: - Short Description Vertical: type: - string - 'null' default: null GlobalBrandId: type: - integer - 'null' examples: - 122323 CreatedBy: type: string examples: - Admin DateTimeCreated: type: string examples: - 12/27/2022 14:08:31 PartnerId: type: integer description: Unique partner id examples: - 21 LastModifiedBy: type: string examples: - Admin LastModified: type: string examples: - 01/06/2023 09:13:40 BrandId: type: integer description: ID of the custom brand (advertiser). Use this value as `AdvertiserId` when creating or updating a campaign; do not use it as campaign `BrandId`. examples: - 50852 required: - BrandName - BillingName required: - type - href - Brand CampaignPublishersSinglePublisherSuccessResponseModel: type: object description: Used when `publisherId` param is in query properties: type: const: CampaignPublisher description: Type of Search examples: - CampaignPublisher href: type: string description: CreatorIQ API URL to get campaign information examples: - https://apis.creatoriq.com/crm/v1/campaign/42066/publishers CampaignPublisher: type: object description: Single publisher in Campaign when `publisherId` param is in query allOf: - $ref: '#/components/schemas/CampaignPublisherModel' - type: object properties: Payable: type: boolean PayableDate: type: - string - 'null' format: date-time examples: - '2023-08-03 15:07:36' NotPayableReason: type: - string - 'null' examples: - PayPal email not set HasPayments: type: string examples: - '0' HasFixedPayments: type: boolean IsFixedPaymentRejected: type: boolean PaymentRejectionNote: type: - string - 'null' examples: - Some rejection note IntegrationSettings: $ref: '#/components/schemas/IntegrationSettingsModel' NetworkCampaignName: type: - string - 'null' description: External campaign name examples: - NetworkCampaignCola TrackingLinkCreationType: type: string enum: - mass-generate - link-by-link - null description: Exists only if if campaign has TrackingLinkCreationType value CampaignFlags: $ref: '#/components/schemas/CampaignFlagsModel' description: Exists only when `sections` param contains `CampaignFlags` SocialAccounts: type: array description: Exists only when `sections` param contains `SocialAccounts` items: type: object properties: Id: type: integer description: Social Account ID in CRM examples: - 5724572 Network: type: string enum: - youtube - twitter - facebook - instagram - google - vine - weibo - line - tiktok - twitch - tumblr - pinterest - snapchat - linkedin - reddit - web - blog description: Network name examples: - instagram SocialNetworkId: type: string description: Social Network account ID examples: - '7729304922060436499' NetworkUser: type: string description: Social Network username examples: - UCvdJ4OZRbLkH3RTRvySQjxRc FullName: type: string description: Social Network full name examples: - Andrew Torwalds YoutubeTitle: type: string description: Youtube account title examples: - My YT channel IsCreatorMarketplaceEnabled: type: integer enum: - 0 - 1 description: Flag of Creator Marketplace enabled examples: - 1 required: - Id - Network - SocialNetworkId - NetworkUser - FullName - YoutubeTitle - IsCreatorMarketplaceEnabled required: - Payable - PayableDate - NotPayableReason - HasPayments - HasFixedPayments - IsFixedPaymentRejected - PaymentRejectionNote - IntegrationSettings - NetworkCampaignName required: - type - href - CampaignPublisher PromotionModel: type: object properties: PromotionId: type: integer examples: - 1234 CampaignId: type: integer examples: - 27896 Name: type: - string - 'null' examples: - Apple iPhone 13 256GB Green Description: type: - string - 'null' examples: - product Type: type: string examples: - product CreatedAt: type: string examples: - '2026-05-04 11:04:34' CreatedById: type: integer examples: - 100119139 UpdatedAt: type: string examples: - '2026-05-04 11:04:34' UpdatedById: type: integer examples: - 100119139 Status: type: string examples: - Auto IsDeleted: type: integer default: 0 examples: - 0 ExternalPromotionId: type: - string - 'null' examples: - '8563122176283' ParamsJSON: type: object examples: - {} Instruction: type: - string - 'null' examples: - instructions DestinationUrl: type: - string - 'null' examples: - https://ciq-qa-teststore-2.myshopify.com/products/apple-iphone-13-256gb-green PlatformsJSON: type: object examples: - {} required: - PromotionId - CampaignId - Name - Description - Type - CreatedAt - CreatedById - UpdatedAt - UpdatedById - Status - IsDeleted - ExternalPromotionId - ParamsJSON - Instruction - DestinationUrl - PlatformsJSON AdditionalRequirementsSuccessModel: type: object properties: type: const: PublishersAdditionalRequirementsCollection description: Type of Search examples: - PublishersAdditionalRequirementsCollection href: type: string description: Link to fetch current campaign Publisher Additional Requirements examples: - https://apis.creatoriq.com/crm/v1/api/PublishersAdditionalRequirements count: type: integer description: Number of records in current response examples: - 20 total: type: integer description: Total number of found rows examples: - 20 page: type: integer description: Current page examples: - 1 PublishersAdditionalRequirementsCollection: type: array items: $ref: '#/components/schemas/PublishersAdditionalRequirementModel' required: - type - href - count - total - page - PublishersAdditionalRequirementsCollection PayoutModel: type: array description: Payouts list for campaign items: type: object properties: CampaignId: type: integer description: Unique campaign id examples: - 100 CampaignName: type: string description: Campaign name examples: - Campaign CampaignLogoURL: type: string description: Url to campaign logo examples: - https://social-pictures-storage.s3.amazonaws.com/a7bdbe0792cc23fb83976e1c3bc548e3_1600461437.png Currency: type: string examples: - USD Paid: type: integer enum: - 0 - 1 x-deprecated: true PublisherId: type: integer description: Unique publisher id examples: - 100 PublisherName: type: string description: Publisher name examples: - Neo PublisherLogoURL: type: string description: Url to publisher logo format: uri examples: - https://social-pictures-storage.s3.amazonaws.com/a7bdbe0792cc23fb83976e1c3bc548e3_1600461437.png CPM: type: - string - 'null' default: null CPC: type: - string - 'null' default: null CPA: type: - string - 'null' default: null CPS: type: - string - 'null' default: null CPL: type: - string - 'null' default: null CPV: type: - string - 'null' default: null Status: type: string description: Campaign status examples: - Accepted Clicks: type: - integer - 'null' examples: - 100 OfferURLHash: type: - string - 'null' description: Offer url hash format: uri examples: - https://google.com Note: type: - string - 'null' default: null AccountsParticipation: type: string enum: - All - BiggestPerNetwork - null examples: - All ContentApproval: type: string enum: - Required - Network approval required - null description: Specify if сampaign need content approval or not examples: - Required PostApproval: type: string enum: - Required - Not Required - null description: 'Flag for live post approval. * Required => live post approval enabled * Not Required => live post approval not enabled ' SubmitByDate: type: - string - 'null' description: Submit content before date examples: - '2016-01-20 16:00:00.0000000 -08:00' PublishAfter: type: - string - 'null' description: Publish posts or content after date this date examples: - '2017-06-01 00:00:00.0000000 +00:00' PublishBefore: type: - string - 'null' description: Publish posts or content before date this date examples: - '2017-09-30 00:00:00.0000000 +00:00' ContentRejectionNote: type: - string - 'null' default: null RespondByDate: type: - string - 'null' default: null examples: - '2020-02-29' FixedFee: type: - number - 'null' default: null CPVAmount: type: - number - 'null' default: null CPCAmount: type: - number - 'null' default: null PayoutCap: type: - number - 'null' default: null PlatformYouTube: type: integer enum: - 0 - 1 - null description: '* 0 or null represents YouTube is disabled for campaign * 1 represents YouTube is enabled for campaign ' PlatformTwitter: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformFacebook: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformInstagram: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformGoogle: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformVine: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformPinterest: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformTumblr: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformSnapchat: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformWeb: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformMusically: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true x-deprecated: true PlatformTwitch: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformLinkedIn: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformTikTok: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformWeibo: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true PlatformLine: type: integer enum: - 0 - 1 - null description: Platform Web use. 0 - false; 1 - true RequiredPostsYouTube: type: - integer - 'null' description: Required posts for YouTube default: null examples: - 3 RequiredPostsTwitter: type: - integer - 'null' description: Count required posts for Twitter default: null examples: - 3 RequiredPostsFacebook: type: - integer - 'null' description: Count required posts for Facebook examples: - 33 RequiredPostsInstagram: type: - integer - 'null' description: Count required posts for Instagram default: null examples: - 3 RequiredPostsGoogle: type: - integer - 'null' description: Count required posts for Google default: null examples: - 3 RequiredPostsVine: type: - integer - 'null' description: Count required posts for Vine default: null examples: - 3 RequiredPostsPinterest: type: - integer - 'null' description: Count required posts for Pinterest default: null examples: - 3 RequiredPostsTumblr: type: - integer - 'null' description: Count required posts for Tumblr examples: - 3 RequiredPostsSnapchat: type: - integer - 'null' description: Count required posts for Snapchat default: null examples: - 3 RequiredPostsWeb: type: - integer - 'null' description: Count required posts for Web default: null examples: - 3 RequiredPostsMusically: type: - integer - 'null' description: Count required posts for Musically default: null examples: - 3 RequiredPostsTwitch: type: - integer - 'null' description: Required posts for Twitch default: null RequiredPostsLinkedIn: type: - integer - 'null' description: Count required posts for LinkedIn default: null RequiredPostsTikTok: type: - integer - 'null' description: Count required posts for TikTok default: null RequiredPostsWeibo: type: - integer - 'null' description: Count required posts for Weibo default: null RequiredPostsLine: type: - integer - 'null' description: Count required posts for Line examples: - 23 PublisherPlatformYouTube: type: integer enum: - 0 - 1 - null examples: - 1 PublisherPlatformTwitter: type: integer enum: - 0 - 1 - null examples: - 1 PublisherPlatformFacebook: type: integer enum: - 0 - 1 - null examples: - 1 PublisherPlatformInstagram: type: integer enum: - 0 - 1 - null examples: - 1 PublisherPlatformGoogle: type: integer enum: - 0 - 1 - null examples: - 1 PublisherPlatformVine: type: integer enum: - 0 - 1 - null examples: - 0 PublisherPlatformPinterest: type: integer enum: - 0 - 1 - null examples: - 1 PublisherPlatformTumblr: type: integer enum: - 0 - 1 - null examples: - 1 PublisherPlatformSnapchat: type: integer enum: - 0 - 1 - null PublisherPlatformWeb: type: integer enum: - 0 - 1 - null PublisherPlatformMusically: type: integer enum: - 0 - 1 - null x-deprecated: true PublisherPlatformTwitch: type: integer enum: - 0 - 1 - null PublisherPlatformLinkedIn: type: integer enum: - 0 - 1 - null PublisherPlatformTikTok: type: integer enum: - 0 - 1 - null PublisherPlatformWeibo: type: integer enum: - 0 - 1 - null PublisherPlatformLine: type: integer enum: - 0 - 1 - null PublisherRequiredPostsYouTube: type: - integer - 'null' examples: - 3 PublisherRequiredPostsTwitter: type: - integer - 'null' examples: - 4 PublisherRequiredPostsFacebook: type: - integer - 'null' examples: - 4 PublisherRequiredPostsInstagram: type: - integer - 'null' examples: - 4 PublisherRequiredPostsGoogle: type: - integer - 'null' examples: - 4 PublisherRequiredPostsVine: type: - integer - 'null' examples: - 5 PublisherRequiredPostsPinterest: type: - integer - 'null' default: null examples: - 3 PublisherRequiredPostsTumblr: type: - integer - 'null' default: null examples: - 3 PublisherRequiredPostsSnapchat: type: - integer - 'null' default: null examples: - 3 PublisherRequiredPostsWeb: type: - integer - 'null' default: null examples: - 3 PublisherRequiredPostsMusically: type: - integer - 'null' default: null examples: - 3 x-deprecated: true PublisherRequiredPostsTwitch: type: - integer - 'null' examples: - 4 PublisherRequiredPostsLinkedIn: type: - integer - 'null' examples: - 4 PublisherRequiredPostsTikTok: type: - integer - 'null' examples: - 4 PublisherRequiredPostsWeibo: type: - integer - 'null' examples: - 3 PublisherRequiredPostsLine: type: - integer - 'null' examples: - 3 CampaignPlatformYouTube: type: integer enum: - 0 - 1 - null CampaignPlatformTwitter: type: integer enum: - 0 - 1 - null CampaignPlatformFacebook: type: integer enum: - 0 - 1 - null CampaignPlatformInstagram: type: integer enum: - 0 - 1 - null CampaignPlatformGoogle: type: integer enum: - 0 - 1 - null CampaignPlatformVine: type: integer enum: - 0 - 1 - null CampaignPlatformPinterest: type: integer enum: - 0 - 1 - null CampaignPlatformTumblr: type: integer enum: - 0 - 1 - null CampaignPlatformSnapchat: type: integer enum: - 0 - 1 - null CampaignPlatformWeb: type: integer enum: - 0 - 1 - null CampaignPlatformMusically: type: integer enum: - 0 - 1 - null CampaignPlatformTwitch: type: integer enum: - 0 - 1 - null CampaignPlatformLinkedIn: type: integer enum: - 0 - 1 - null CampaignPlatformTikTok: type: integer enum: - 0 - 1 - null CampaignPlatformWeibo: type: integer enum: - 0 - 1 - null CampaignPlatformLine: type: integer enum: - 0 - 1 - null CampaignRequiredPostsYouTube: type: integer minimum: 0 examples: - 10 CampaignRequiredPostsTwitter: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsFacebook: type: - integer - 'null' examples: - 4 CampaignRequiredPostsInstagram: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsGoogle: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsVine: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsPinterest: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsTumblr: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsSnapchat: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsWeb: type: integer minimum: 0 examples: - 4 CampaignRequiredPostsMusically: type: integer minimum: 0 examples: - 5 CampaignRequiredPostsTwitch: type: - integer - 'null' minimum: 0 examples: - 3 CampaignRequiredPostsLinkedIn: type: integer minimum: 0 examples: - 3 CampaignRequiredPostsTikTok: type: - integer - 'null' minimum: 0 examples: - 3 CampaignRequiredPostsWeibo: type: - integer - 'null' minimum: 0 examples: - 3 CampaignRequiredPostsLine: type: - integer - 'null' examples: - 2 RequiredPostsTotal: type: integer description: Total required posts minimum: 0 examples: - 3 HasCustomRequirements: type: integer enum: - 0 - 1 - null ActualPostsYouTube: type: string examples: - '10' ActualPostsFacebook: type: string examples: - '10' ActualPostsTwitter: type: string examples: - '10' ActualPostsInstagram: type: string examples: - '10' ActualPostsGoogle: type: string examples: - '10' ActualPostsVine: type: string examples: - '10' ActualPostsPinterest: type: string examples: - '120' ActualPostsTumblr: type: string examples: - '120' ActualPostsSnapchat: type: string examples: - '120' ActualPostsWeb: type: string examples: - '120' ActualPostsMusically: type: string examples: - '120' ActualPostsTwitch: type: string examples: - '120' ActualPostsLinkedIn: type: string examples: - '120' ActualPostsTikTok: type: string examples: - '120' ActualPostsWeibo: type: string examples: - '10' ActualPostsLine: type: string examples: - '10' ActualPostsTotal: type: string examples: - '100' Views: type: integer format: int32 minimum: 0 examples: - 3 RequirementsCompleted: type: integer enum: - 0 - 1 DateRequirementsCompleted: type: - string - 'null' examples: - '2020-02-29' DateRequirementsCompletedLastPostDate: type: - string - 'null' examples: - '2020-02-29' DateContentSubmitted: type: - string - 'null' description: Content submitted date examples: - '2019-07-10' DateContentApproved: type: - string - 'null' description: Content approved date examples: - '2020-02-29' CampaignStartDate: type: - string - 'null' description: Campaign start date examples: - '2020-02-29' CampaignEndDate: type: - string - 'null' description: Campaign end date examples: - '2020-02-29' FixedFeeTrigger: type: - number - 'null' default: null PayoutCapTrigger: type: - string - 'null' default: null PublisherCustomPayout: type: - string - 'null' default: null PublisherCustomPayoutCap: type: - string - 'null' default: null AllowCustomPayout: type: - string - 'null' default: null AllowCustomPayoutCap: type: - string - 'null' default: null PayoutPaid: type: - number - 'null' default: null PayoutPaidTrigger: type: - string - 'null' description: Payout paid triger default: null PayoutType: type: string enum: - PerPost - Fixed - null CampaignDefaultPayout: type: - number - 'null' default: null EarningsCPVActual: type: - number - 'null' default: null EarningsCPV: type: - number - 'null' default: null EarningsCPCActual: type: - number - 'null' default: null EarningsCPC: type: - number - 'null' default: null EarningsFixedFee: type: - number - 'null' default: null EarningsTotal: type: - number - 'null' default: null DateLastActivityUpdated: type: - string - 'null' default: null PublisherVerified: type: integer enum: - 0 - 1 - null DateLastContacted: type: - string - 'null' default: null IsPaymentTermInUse: type: integer enum: - 0 - 1 - null PaymentTerm: type: - integer - 'null' default: null DateRequirementsCompletedFilter: type: - string - 'null' default: null examples: - '2020-02-29' ScheduledPosts: type: - integer - 'null' default: null required: - CampaignId IntegrationSettingsModel: type: object properties: AccountConfigurationId: type: integer examples: - 1234 TrackingAddUTM: type: boolean examples: - false TrackingLevel: type: string examples: - publisher PromotionType: type: string examples: - product PromotionWithType: type: string examples: - link ShortLinkWrapper: type: - integer - 'null' examples: - 50 TrackingLinkCreationType: type: - string - 'null' examples: - mass-generate CouponCodeSettings: type: - object - 'null' examples: - {} AllowPublishersToGenerateLink: type: boolean examples: - false Promotions: type: array items: $ref: '#/components/schemas/PromotionModel' required: - AccountConfigurationId - TrackingAddUTM - TrackingLevel - PromotionType - PromotionWithType - ShortLinkWrapper - TrackingLinkCreationType - AllowPublishersToGenerateLink CampaignActivitySuccessResponseModel: type: object properties: type: const: CampaignActivity description: Type of Search examples: - CampaignActivity href: type: string description: Link to fetch current campaign activity examples: - https://apis.creatoriq.com/crm/v1/api/campaign/856302/activity CampaignActivity: type: object description: Campaign activity data properties: items: type: array description: An array of all the posts for the campaign items: type: object description: Post info with statistics properties: Id: type: integer format: int32 examples: - 3136783 CampaignId: type: integer format: int32 examples: - 44560 SocialNetwork: type: string examples: - Instagram SocialNetworkId: type: string examples: - '17773493878' PublisherId: type: integer format: int32 examples: - 1453672 UserName: type: string examples: - sportlivelemur Type: type: - string - 'null' description: 'Indicates how the post was added to the campaign. `manual` — post was added manually via API or UI (link, file upload, or stream). `null` or other values — post was automatically discovered and matched to the campaign. For content format (story, video, image, etc.), use `PostType` instead. ' default: null examples: - manual PostId: type: string examples: - '2203166338554101407_17773493878' Score: type: string examples: - '' x-deprecated: true EarnedMedia: type: integer description: The post's earned media calculated by formula format: int32 examples: - 1001 ActualReach: type: - string - 'null' description: Reach that is manually inputted from a CreatorIQ user, often after a creator has shared a screenshot of the metrics of this post. Social platforms - Instagram, TikTok, Facebook, Twitter, Blog. Type - Post Level default: null NetworkReach: type: - string - 'null' description: Reach for authenticated accounts. This value comes directly from the social platform. Social platforms - Instagram, TikTok, Facebook, Twitter, Blog. Type - Post Level/Authenticated Accounts default: null EstimatedReach: type: integer description: "Estimated value of reach is calculated using regression models trained on historical data. \nFor Instagram, different models are used for each post type (e.g., image, carousel, reel, story), based on metrics like impressions, engagement, and followers. For other platforms (e.g., TikTok, Facebook, Twitter, Pinterest), reach is estimated from impressions using a power-law scaling function.\nThis value is populated if the Reach metric is unavailable because the social account is not authenticated, and no value is entered manually. For YouTube, Twitch, and Snapchat, estimated reach is not provided.\nFor example, if actual or estimated impressions are 20,000, the resulting EstimatedReach would be approximately 15,400.\n" format: int32 examples: - 1 EMV: type: integer description: "Estimated Media Value (EMV) is a calculated representation of the earned media value of a post, based on engagement metrics. The specific metrics and weights used vary by social platform (e.g., likes, comments, shares, views, retweets, etc).\nEMV quantifies the approximate monetary value generated by organic post engagement using platform-specific logic and scaling curves.\nThis value is populated when engagement data is available and is intended to help benchmark the performance of influencer content or campaigns in monetary terms. \nThe calculation involves computing a weighted linear value from platform-defined engagement types, followed by a nonlinear (logarithmic) scaling function to account for saturation effects.\n" format: int32 examples: - 1 Reach: type: integer description: "Number of unique impressions.\nThis can come from either `NetworkReach` for authenticated accounts \nOR reach value manually entered by the creator (`ActualReach`) \nOR estimated reach value (`EstimatedReach`) which is calculated in the absence of `NetworkReach` and `ActualReach`. Social platforms - Instagram, TikTok, Facebook, Twitter, Blog. Type - Post Level/Authenticated Accounts\n" format: int32 examples: - 1 ExtendedReach: type: - string - 'null' description: for Twitter means sum of all the followers of accounts that have retweeted the post. Social platforms - Twitter. Type - Post Level default: null x-deprecated: true Likes: type: integer description: Number of likes. Social platforms - Instagram,TikTok,Youtube,Facebook,Twitter,Linkedin,Snapchat. Type - Post Level format: int32 examples: - 20 Comments: type: integer description: Number of comments. Social platforms - Instagram,TikTok,Youtube,Facebook,Twitter,Linkedin,Blog,Twitch. Type - Post Level format: int32 examples: - 10 Retweets: type: - string - 'null' description: Post Retweets (Shares). Social platforms - Twitter. Type - Post Level. default: null Views: type: - string - 'null' description: Number of post views. Social platforms - All. Type - Post Level. default: null x-deprecated: true EngagedViews_next: type: - string - 'null' description: 'Number of post views. Social platforms - All. Type - Post Level. > **Warning**: The **Views** field will be deprecated soon. Use this field instead of it. ' default: null MinutesWatched: type: - string - 'null' description: Aggregate number of minutes users have spent watching a specific video. Social platforms - Youtube. Type - Post Level. default: null examples: - '2' PostKey: type: - string - 'null' default: null LinkId: type: - string - 'null' default: null Status: type: string examples: - Published ApprovedBy: type: - string - 'null' default: null SuspendedBy: type: - string - 'null' default: null UpdatedBy: type: string examples: - API PostType: type: string examples: - image TotalShares: type: string description: Times your audience DM’d the post. Social platforms - Instagram,TikTok,Youtube, Facebook, Pinterest, Linkedin. Type - Post Level. examples: - '3' FacebookLikes: type: - string - 'null' description: Total facebook likes. Social platforms - Facebook. Type - Post Level. default: null FacebookShares: type: - string - 'null' description: Social platforms - Facebook. Type - Post Level. default: null FacebookComments: type: - string - 'null' description: Social platforms - Facebook. Type - Post Level. default: null TwitterShares: type: - string - 'null' description: Social platforms - Twitter. Type - Post Level. default: null GooglePlusShares: type: - string - 'null' default: null x-deprecated: true PinterestShares: type: - string - 'null' description: Social platforms - Pinterest. Type - Post Level. default: null NotFound: type: - string - 'null' default: null PublisherName: type: string examples: - sportlivelemur CampaignName: type: string examples: - SA_Scheduled_2 NetworkPublisherId: type: string examples: - '10000637647' PartnerId: type: integer format: int32 examples: - 21 LogoURL: type: string examples: - https://instagram.fbom5-1.fna.fbcdn.net/v/t51.2885-19/66366700_676199099563329_6160046265783549952_n.jpg?stp=dst-jpg_s320x320&_nc_ht=instagram.fbom5-1.fna.fbcdn.net&_nc_cat=109&_nc_ohc=u6OVofiisgwAX-hRroz&edm=ABfd0MgBAAAA&ccb=7-4&oh=00_AT-_BBCJ-umNGXAE-JSr_OLlzUsCg2yoJWEG3aFlXYcb5Q&oe=625D8016&_nc_sid=7bff83 StartDate: type: string format: date examples: - '2019-10-01' EndDate: type: string format: date examples: - '2020-05-27' FlagshipProperty: type: string examples: - sportlivelemur AverageViewDuration: type: - number - 'null' description: 'Average length of a video playback in minutes. Type - Post Level. Social platforms - Facebook, Instagram, Snapchat, Tiktok, Web, YouTube ' default: null examples: - 2.3 AverageViewPercentage: type: - string - 'null' description: Avg percentage of a video watched during a video playback. Social platforms - Youtube. Type - Post Level. default: null SubscribersGained: type: - string - 'null' description: Times users subscribed to a channel from the video watch page. Social platforms - Youtube. Type - Post Level/Authenticated Accounts. default: null AvgViewsPerPost: type: - number - 'null' description: Average views per post. Social platforms - Blog. Type - Post Level. default: null examples: - 2.3 x-deprecated: true AvgEngagedViewsPerPost_next: type: - number - 'null' description: 'Average views per post. Social platforms - Blog. Type - Post Level. > **Warning**: The **AvgViewsPerPost** field will be deprecated soon. Use this field instead of it. ' default: null examples: - 2.3 SubscribersLost: type: - string - 'null' description: Times users unsubscribed from a channel. Social platforms - Youtube. Type - Post Level/Authenticated Accounts. default: null AnnotationClickThroughRate: type: - string - 'null' description: The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. Social platforms - Youtube. Type - Post Level. default: null AnnotationCloseRate: type: - string - 'null' description: The ratio of annotations that viewers closed to the total number of annotation impressions. Social platforms - Youtube. Type - Post Level. default: null MonetizedPlaybacks: type: - string - 'null' default: null x-deprecated: true GrossRevenue: type: - string - 'null' default: null x-deprecated: true ImpressionBasedCpm: type: - string - 'null' default: null x-deprecated: true Duration: type: - string - 'null' description: The length of the video. For example, a value of Pinterest15M33S indicates that the video is 15 minutes and 33 seconds long. Social platforms - Youtube, Pinterest. Type - Post Level. default: null ActualImpressions: type: - string - 'null' description: Impressions that are manually inputted from a CreatorIQ user, often after a creator has shared a screenshot of the metrics of this post. Social platforms - Instagram,Facebook,Twitter,Pinterest. Type - Post Level. default: null x-deprecated: true ActualViews_next: type: - string - 'null' description: 'Impressions that are manually inputted from a CreatorIQ user, often after a creator has shared a screenshot of the metrics of this post. Social platforms - Instagram,Facebook,Twitter,Pinterest. Type - Post Level. > **Warning**: The **ActualImpressions** field will be deprecated soon. Use this field instead of it. ' default: null EngagementRate: type: integer description: "Value calculated based on the formula `TotalEngagements / BaseMetricValue`. \nThe value is computed depending on the `BaseMetric` (followers, impressions, reach, etc.) configured within the Campaign Settings. Social platforms - ALL. Type - Post Level.\n" format: int32 examples: - 0 PaidImpressions: type: - integer - 'null' description: The number of times your ads were on screen. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null examples: - 842 x-deprecated: true PaidViews_next: type: - integer - 'null' description: 'The number of times your ads were on screen. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. > **Warning**: The **PaidViews_next** field will be deprecated soon. Use this field instead of it. ' default: null examples: - 842 PaidReach: type: - integer - 'null' description: The number of people who saw your ads at least once. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null examples: - 92387 PaidEngagement: type: - integer - 'null' description: The total number of actions that people take involving your ads. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null examples: - 323 PaidEngagementRate: type: - number - 'null' description: The total number of actions that people take involving your ads divided by the number of people who saw it. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null examples: - 3235.4 Boosted: type: integer description: Boosted post flag. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. format: int32 examples: - 23 PaidClicks: type: - string - 'null' description: The number of clicks on your ads. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null PaidLinkClicks: type: - string - 'null' description: The number of people that click on links that take people off Facebook-owned properties. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null PaidViews: type: - string - 'null' description: The number of times your view ads were viewed for at least three seconds. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null x-deprecated: true PaidEngagedViews_next: type: - string - 'null' description: 'The number of times your view ads were viewed for at least three seconds. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. > **Warning**: The **PaidViews** field will be deprecated soon. Use this field instead of it. ' default: null PaidLikes: type: - string - 'null' description: The unique number of people that put a reaction on the ad. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null PaidComments: type: - string - 'null' description: The number of times your ads were commented. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null PaidTotalShares: type: - string - 'null' description: The number of times your ads were shared. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null PaidSaves: type: - string - 'null' description: The number of times your ads were saved. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null CombinedImpressions: type: integer description: Paid impressions + impressions. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. format: int32 examples: - 32 CombinedViews_next: type: integer description: 'Paid impressions + impressions. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. > **Warning**: The **CombinedImpressions** field will be deprecated soon. Use this field instead of it. ' format: int32 examples: - 32 CombinedReach: type: integer description: Paid reach + reach. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. format: int32 examples: - 1 CombinedEngagement: type: string description: Paid engagment + engagment. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. examples: - '0' CombinedClicks: type: - string - 'null' description: Paid clicks + clicks. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null CombinedViews: type: - string - 'null' description: Paid views + views. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null x-deprecated: true CombinedEngagedViews_next: type: - string - 'null' description: 'Paid views + views. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. > **Warning**: The **CombinedViews** field will be deprecated soon. Use this field instead of it. ' default: null CombinedLikes: type: integer description: Paid likes + likes. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. format: int32 examples: - 0 CombinedComments: type: integer description: Paid comments + comments. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. format: int32 examples: - 0 CombinedTotalShares: type: - string - 'null' description: Paid shares + shares. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null CombinedSaves: type: - string - 'null' description: Paid saves + saves. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. default: null CombinedEngagementRate: type: integer description: Paid engagement rate + engagement rate. Social platforms - Facebook,Instagram. Type - Post Level/Authenticated Accounts. format: int32 examples: - 2 NetworkImpressions: type: - string - 'null' description: Impressions for authenticated accounts. This comes directly from the social platform. Social platforms - ALL. Type - Post Level/Authenticated Accounts. default: null x-deprecated: true NetworkViews_next: type: - string - 'null' description: 'Impressions for authenticated accounts. This comes directly from the social platform. Social platforms - ALL. Type - Post Level/Authenticated Accounts. > **Warning**: The **NetworkImpressions** field will be deprecated soon. Use this field instead of it. ' default: null EstimatedImpressions: type: integer description: 'Estimated value of impressions is calculated using regression models trained on historical post and account data (such as followers, likes, comments, and post age). This value is populated if the Impressions metric is unavailable because the social account is not authenticated, and no value is entered manually. For Instagram, separate models are used for stories and post types (e.g., image, carousel, reel). For TikTok, Facebook, Twitter, and Pinterest, impressions are estimated from actual or predicted views. For YouTube, Twitch, and Snapchat, estimated impressions are not provided. For example, if a post has 100,000 followers and 2,000 likes, and no actual impression value is available, a regression model may estimate the impressions as approximately 18,500, depending on the platform, post type, and engagement level. ' format: int32 examples: - 2 EstimatedViews_next: type: integer description: 'Estimated value of impressions is calculated using regression models trained on historical post and account data (such as followers, likes, comments, and post age). This value is populated if the Impressions metric is unavailable because the social account is not authenticated, and no value is entered manually. For Instagram, separate models are used for stories and post types (e.g., image, carousel, reel). For TikTok, Facebook, Twitter, and Pinterest, impressions are estimated from actual or predicted views. For YouTube, Twitch, and Snapchat, estimated impressions are not provided. For example, if a post has 100,000 followers and 2,000 likes, and no actual impression value is available, a regression model may estimate the impressions as approximately 18,500, depending on the platform, post type, and engagement level. > **Warning**: The **EstimatedImpressions** field will be deprecated soon. Use this field instead of it. ' format: int32 examples: - 2 FollowersAtTimeOfPost: type: string description: Followers at time of post. Social platforms - Instagram,TikTok,Youtube,Twitter,Pinterest,Twitch,Blog. Type - Post Level/Authenticated Accounts. examples: - '23' FBIGId: type: string examples: - '17857796017633696' Thumbnail: type: string examples: - https://instagram.com/p/B6TOByunX6f/media/?size=m SavedPicture: type: string examples: - https://social-pictures-storage.s3-us-west-1.amazonaws.com/Instagram/2203166338554101407_17773493878-6b003706447a776ed5439726a1d7ea33.jpg Replies: type: - string - 'null' description: Messages sent in reply to a story. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null Exits: type: - string - 'null' description: Times a user stopped watching a story entirely. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null TapsForward: type: - string - 'null' description: Times the audience tapped forward to go to the next story of the same creator. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null TapsBack: type: - string - 'null' description: Times your audience tapped back to replay a story. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null SwipeAways: type: - string - 'null' description: Times audience swiped right to next user’s story. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null PostTitle: type: - string - 'null' default: null Uniques: type: - string - 'null' default: null x-deprecated: true Note: type: - string - 'null' default: null FTCCompliant: type: - string - 'null' default: null SwipeUps: type: - string - 'null' description: Times audience clicked on stickers that link to an external URL. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null StickerTaps: type: - string - 'null' description: Interactions with stickers such as geotags or hashtags. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null Sentiment: type: - string - 'null' default: null x-deprecated: true ManualReachFlag: type: integer description: Indicates if the value of `ActualReach` was used to populate the `Reach` metric. Value `1` indicates TRUE, and `0` indicates FALSE. format: int32 examples: - 0 ManualImpressionsFlag: type: integer description: Indicates if the value `ActualImpressions` was used to populate the `Impressions` metric. Value `1` indicates TRUE, and `0` indicates FALSE. format: int32 examples: - 0 ManualViewsFlag_next: type: integer description: 'Indicates if the value `ActualImpressions` was used to populate the `Impressions` metric. Value `1` indicates TRUE, and `0` indicates FALSE. > **Warning**: The **ManualImpressionsFlag** field will be deprecated soon. Use this field instead of it. ' format: int32 examples: - 0 SocialId: type: integer format: int32 examples: - 2913479 Dislikes: type: string examples: - '0' x-deprecated: true Saved: type: - string - 'null' description: Times the post is saved into a collection. Social platforms - Instagram. Type - Post Level/Authenticated Accounts. default: null Linked: type: integer format: int32 examples: - 0 Unlinked: type: integer format: int32 examples: - 1 LinkBroken: type: integer format: int32 examples: - 0 Verified: type: integer format: int32 examples: - 0 TokenInvalidDate: type: - string - 'null' default: null LinkedAt: type: - string - 'null' default: null Business: type: integer format: int32 examples: - 0 SubmitByDate: type: - string - 'null' default: null NetworkEngagements: type: - integer - 'null' description: Times people interacted with a content. Social platforms - ALL. Type - Post Level/Manual. default: null InstagramShares: type: - string - 'null' description: Times your audience DM’d the post. Social platforms - Instagram. Type - Post Level/Manual. default: null ProfileVisits: type: - string - 'null' description: The number of times your profile was visited. Social platforms - Instagram. Type - Post Level/Manual. default: null Follows: type: - string - 'null' description: The number of accounts that started following you. Social platforms - Instagram. Type - Post Level. default: null CampaignStatus: type: string examples: - Active BoardId: type: - string - 'null' default: null BoardUrl: type: - string - 'null' default: null BoardsCount: type: - string - 'null' default: null Saves: type: - string - 'null' description: The number of times the post was saved. Social platforms - Instagram. Type - Post Level. default: null isVerifiedBySocialNetwork: type: integer format: int32 examples: - 0 DateSubmitted: type: string examples: - '2019-12-20 08:05:15' DateApproved: type: - string - 'null' default: null DateSuspended: type: - string - 'null' default: null PostLink: type: string examples: - https://instagram.com/p/B6TOByunX6f Post: type: string examples: - cava
LastUpdated:
type: string
examples:
- '2021-02-16 20:50:37'
UserNameTitle:
type: string
examples:
- sportlivelemur
Engagement:
type: string
description: Likes + Comments + Shares = total Actions. Social platforms - ALL (except Blog). Type - Post Level.
examples:
- '6'
Clicks:
type:
- string
- 'null'
description: Number of times the post was clicked. Social platforms - Instagram,TikTok,Facebook,Twitter,Pinterest. Type - Post Level.
default: null
PostClicks:
type:
- string
- 'null'
description: Number of times the post was clicked. Social platforms - Instagram,TikTok,Facebook,Twitter,Pinterest. Type - Post Level.
default: null
TotalReach:
type: integer
description: Sum of `Reach` and `ExtendedReach`. This is now deprecated.
format: int32
examples:
- 1
LinkClicks:
type:
- string
- 'null'
description: The number of clicks from a creator’s link. Type - Campaign metrics
default: null
PostConversionMetrics:
type:
- string
- 'null'
default: null
Impressions:
type: integer
description: "Number of times people saw the post. \nThis can come from either `NetworkImpressions` for authenticated accounts \nOR impressions value manually entered by the creator (`ActualImpressions`) \nOR estimated impressions calculated in the absence of `NetworkImpressions` and `ActualImpressions`. Social platforms - Instagram,Youtube,Facebook,Twitter,Linkedin,Blog,Twitch,Snapchat,Pinterest,Tumblr. Type - Post Level.\n"
format: int32
examples:
- 0
Views_next:
type: integer
description: "Number of times people saw the post. \nThis can come from either `NetworkImpressions` for authenticated accounts \nOR impressions value manually entered by the creator (`ActualImpressions`) \nOR estimated impressions calculated in the absence of `NetworkImpressions` and `ActualImpressions`. Social platforms - Instagram,Youtube,Facebook,Twitter,Linkedin,Blog,Twitch,Snapchat,Pinterest,Tumblr. Type - Post Level.\n> **Warning**: The **Impressions** field will be deprecated soon. Use this field instead of it.\n"
format: int32
examples:
- 0
SocialMediaValue:
type: integer
format: int32
examples:
- 1001
EstimatedReachFlag:
type: integer
description: Value `1` indicates if the `EstimatedReach` is used as the `Reach` value.
format: int32
examples:
- 1
EstimatedImpressionsFlag:
type: integer
description: Value `1` indicates if the `EstimatedImpressions` is used as the value of the `Impressions` metric.
format: int32
examples:
- 1
EstimatedViewsFlag_next:
type: integer
description: 'Value `1` indicates if the `EstimatedImpressions` is used as the value of the `Impressions` metric.
> **Warning**: The **EstimatedImpressionsFlag** field will be deprecated soon. Use this field instead of it.
'
format: int32
examples:
- 1
BaseMetric:
type: string
description: 'The denominator used in the calculation of the Engagement Rate.
It’s configured at Network (Application Settings → Campaigns → Engagement Rate) and Campaign level (Campaign Settings → Advanced → metrics → Engagement Rate) within the CreatorIQ app.
We recommend choosing `Videos` as the `BaseMetric` for video content and `Reach` for static posts that require authentication.
If you do not require creators to authenticate, then using followers is recommended.
'
examples:
- Followers
BaseMetricValue:
type: integer
description: Value of the `BaseMetric` used to calculate the Engagement Rate.
format: int32
examples:
- 1
CloseUps:
type:
- string
- 'null'
description: Times people viewed a close-up version of your Pin. Social platforms - Pinterest. Type - Post Level.
default: null
PeakStreamConcurrentViews:
type:
- string
- 'null'
description: Maximum number of people tuning in at the same time during the stream. Social platforms - Twitch. Type - Post Level.
default: null
AvgStreamConcurrentViews:
type:
- string
- 'null'
description: Average number of people tuning in at the same time, taken at regular intervals and averaged out across the duration of the stream. Social platforms - Twitch. Type - Post Level.
default: null
SubscribersAtTimeOfPost:
type:
- string
- 'null'
description: Times users subscribed to a channel from the video watch page. Social platforms - Youtube. Type - Post Level.
default: null
EstimatedUniqueStreamViews:
type:
- string
- 'null'
description: Aggregate number of views on all live streams. Social platforms - Twitch. Type - Post Level.
default: null
Votes:
type:
- string
- 'null'
description: Times your audience participated in a poll. Social platforms - Instagram. Type - Post Level.
default: null
RequirementLinked:
type: integer
format: int32
examples:
- 0
PaidBaseMetricValue:
type:
- string
- 'null'
description: Paid base metric value. Social platforms - Instagram. Type - Post Level.
default: null
IGBaseMetricValue:
type: integer
description: Instagram base metric value. Social platforms - Instagram. Type - Post Level.
format: int32
examples:
- 1
IGEngagement:
type: string
description: Instagram actions (Likes + Comments + Shares) number. Social platforms - Instagram. Type - Post Level.
examples:
- '4'
IGCombinedEngagement:
type: string
description: Instagram paid engagement + engagement. Social platforms - Instagram. Type - Post Level.
examples:
- '23'
IGPaidEngagement:
type:
- integer
- 'null'
description: Instagram paid engagement. Social platforms - Instagram. Type - Post Level.
default: null
IGCombinedBaseMetricValue:
type: integer
description: Instagram combined base metric value. Social platforms - Instagram. Type - Post Level.
format: int32
examples:
- 1
IGPaidBaseMetricValue:
type:
- string
- 'null'
description: Instagram paid base metric value. Social platforms - Instagram. Type - Post Level.
default: null
pnk_hash:
type:
- string
- 'null'
examples:
- 057a0175c9434a2d1eef6fd1c0a6983b
PaidUniqueReactions:
type:
- string
- 'null'
description: The unique number of people that put a reaction on the ad. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidUniqueComments:
type:
- string
- 'null'
description: The number of times your ads were commented. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidUniqueClicks:
type:
- string
- 'null'
description: The number of people that click on your ads. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidUniqueLinkClicks:
type:
- string
- 'null'
description: The number of people that click by links in your ads. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidUniqueEngagements:
type:
- string
- 'null'
description: The unique number of people that engage with the ad. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidUniqueShares:
type:
- string
- 'null'
description: The unique number of people that share the ad. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidObjective:
type:
- string
- 'null'
description: Paid Objective. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidOffsiteConversions:
type:
- string
- 'null'
description: The total number of offsite conversions across all channels (i.e. views content, searches, adds to cart, purchases) attributed to your ads. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidOnsiteConversions:
type:
- string
- 'null'
description: The total number of onsite conversions across all channels (i.e. post saves, on-facebook purchases, new messaging conversations) attributed to your ads.. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidRelevanceScore:
type:
- string
- 'null'
description: Paid Relevance Score. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidCurrency:
type:
- string
- 'null'
default: null
PaidSpend:
type:
- string
- 'null'
description: The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidFrequency:
type:
- string
- 'null'
description: The average number of times each person saw your ad. This metric is estimated. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidCTR:
type:
- string
- 'null'
description: The percentage of times people saw your ad and performed a click (all). Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidCPC:
type:
- string
- 'null'
description: The average cost for each click (all). Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidCPP:
type:
- string
- 'null'
description: The average cost to reach 1,000 people. This metric is estimated. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidCPM:
type:
- string
- 'null'
description: The average cost for 1,000 impressions. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidAdRecallers:
type:
- string
- 'null'
description: An estimate of the number of additional people who may remember seeing your ads, if asked, within 2 days. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidAdRecallRate:
type:
- string
- 'null'
description: The rate at which an estimated number of additional people, when asked, would remember seeing your ads within 2 days. Social platforms - Facebook,Instagram. Type - Post Level/Need Auth.
default: null
PaidBaseMetric:
type:
- string
- 'null'
default: null
CombinedBaseMetricValue:
type: integer
description: Sum of the organic `BaseMetricValue` and the paid `PaidBaseMetricValue` (if it exists).
format: int32
examples:
- 1
IsPaid:
type:
- string
- 'null'
default: null
MetricSources:
type: array
description: "Represents the source of the metric values such as those for `Reach` or `Impression`.\nEach object in the array contains the `MetricName`, which indicates the name of the metric and `MetricSource`, which indicates the source of the metric populated for a post.\nThe `MetricSource` could be:\n - `Manual` if the metric is manually entered,\n - `SocialNetwork` is the value captured from the social network API \n - `Estimated` if the value is computed without metric data from the API or manual input.\n"
items:
type: object
properties:
MetricName:
type: string
examples:
- Reach
MetricSource:
type: string
examples:
- Estimated
ViewsUnique:
type:
- string
- 'null'
default: null
PaidMediaStats:
type:
- string
- 'null'
default: null
EngagementsNetwork:
type:
- string
- 'null'
default: null
DateSubmittedUTC:
type: string
examples:
- 2019-12-20T16:05:15+0000
ContentTags:
type:
- array
- 'null'
description: Manually added tags to a post
examples:
- - IG reel tag
- IG story tag
items:
type: string
PaidMediaPaidPartnership:
type: integer
enum:
- 0
- 1
description: 'The Paid Partnership label is a feature that indicates when content is part of a paid partnership or branded content campaign. Here''s what it means:
For Instagram (only relevant for Instagram):
- Allows creators to tag brand partners in their posts and mark content as paid partnerships
- Can be used to boost posts and create partnership ads
- Provides transparency about sponsored content and helps maintain compliance with platform guidelines
'
examples:
- 1
pagination:
type: object
description: Pagination Info
properties:
page:
type: string
description: Current page
default: '1'
examples:
- '1'
size:
type: integer
description: Current page size
default: 20
examples:
- 100
total_items:
type: integer
description: Total Items
examples:
- 2376
total_pages:
type: integer
description: Total Pages
default: 1
examples:
- 24
totals:
type: object
description: General info about activity in campaign
properties:
EarnedMedia:
type:
- integer
- 'null'
default: null
examples:
- 58389
Reach:
type:
- integer
- 'null'
description: "Number of unique impressions.\nThis can come from either `NetworkReach` for authenticated accounts \nOR reach value manually entered by the creator (`ActualReach`) \nOR estimated reach value (`EstimatedReach`) which is calculated in the absence of `NetworkReach` and `ActualReach`. Social platforms - Instagram, TikTok, Facebook, Twitter, Blog. Type - Post Level/Authenticated Accounts\n"
examples:
- 1707
ExtendedReach:
type:
- string
- 'null'
description: for Twitter means sum of all the followers of accounts that have retweeted the post. Social platforms - Twitter. Type - Post Level
default: null
x-deprecated: true
Likes:
type:
- integer
- 'null'
description: Number of the post likes. Social platforms - Instagram,TikTok,Youtube,Facebook,Twitter,Linkedin,Snapchat. Type - Post Level
default: null
examples:
- 63
Comments:
type:
- integer
- 'null'
description: Number of comments. Social platforms - Instagram,TikTok,Youtube,Facebook,Twitter,Linkedin,Blog,Twitch. Type - Post Level
default: null
examples:
- 18
Retweets:
type:
- integer
- 'null'
description: Post Retweets (Shares). Social platforms - Twitter. Type - Post Level.
examples:
- 23
Views:
type:
- integer
- 'null'
description: Number of post views. Social platforms - All. Type - Post Level.
examples:
- 100
x-deprecated: true
EngagedViews_next:
type:
- integer
- 'null'
description: 'Number of post views. Social platforms - All. Type - Post Level.
> **Warning**: The **Views** field will be deprecated soon. Use this field instead of it.
'
examples:
- 100
MinutesWatched:
type:
- integer
- 'null'
description: Aggregate number of minutes users have spent watching a specific video. Social platforms - Youtube. Type - Post Level.
examples:
- 1713
Dislikes:
type:
- integer
- 'null'
description: Total dislikes
examples:
- 10
x-deprecated: true
FacebookLikes:
type:
- integer
- 'null'
description: Total facebook likes. Social platforms - Facebook. Type - Post Level.
default: null
examples:
- 100
TotalShares:
type:
- integer
- 'null'
description: Times your audience DM’d the post. Social platforms - Instagram,TikTok,Youtube, Facebook, Pinterest, Linkedin. Type - Post Level.
default: null
examples:
- 100
FacebookShares:
type:
- integer
- 'null'
description: Total Facebook shares. Social platforms - Facebook. Type - Post Level.
default: null
examples:
- 100
FacebookComments:
type:
- integer
- 'null'
description: Total Facebook comments. Social platforms - Facebook. Type - Post Level.
examples:
- 100
TwitterShares:
type:
- integer
- 'null'
description: Total Twitter shares. Social platforms - Twitter. Type - Post Level.
examples:
- 100
GooglePlusShares:
type:
- integer
- 'null'
description: Total Google Plus shares.
examples:
- 100
x-deprecated: true
PinterestShares:
type:
- integer
- 'null'
description: Total Pinterest shares. Social platforms - Pinterest. Type - Post Level.
examples:
- 100
Engagement:
type:
- integer
- 'null'
description: Likes + Comments + Shares = total Actions. Social platforms - ALL (except Blog). Type - Post Level.
examples:
- 24
Impressions:
type:
- integer
- 'null'
description: "Number of times people saw the post. \nThis can come from either `NetworkImpressions` for authenticated accounts \nOR impressions value manually entered by the creator (`ActualImpressions`) \nOR estimated impressions calculated in the absence of `NetworkImpressions` and `ActualImpressions`. Social platforms - Instagram,Youtube,Facebook,Twitter,Linkedin,Blog,Twitch,Snapchat,Pinterest,Tumblr. Type - Post Level.\n"
examples:
- 34
x-deprecated: true
Views_next:
type:
- integer
- 'null'
description: "Number of times people saw the post. \nThis can come from either `NetworkImpressions` for authenticated accounts \nOR impressions value manually entered by the creator (`ActualImpressions`) \nOR estimated impressions calculated in the absence of `NetworkImpressions` and `ActualImpressions`. Social platforms - Instagram,Youtube,Facebook,Twitter,Linkedin,Blog,Twitch,Snapchat,Pinterest,Tumblr. Type - Post Level.\n> **Warning**: The **Impressions** field will be deprecated soon. Use this field instead of it.\n"
examples:
- 34
AverageViewDuration:
type:
- number
- 'null'
description: 'Average length of a video playback in minutes. Type - Post Level.
Social platforms - Facebook, Instagram, Snapchat, Tiktok, Web, YouTube
'
format: float
examples:
- 2.73
OneTimeReach:
type:
- integer
- 'null'
examples:
- 33
x-deprecated: true
OneTimeFollowers:
type:
- integer
- 'null'
examples:
- 34
x-deprecated: true
TotalReach:
type:
- integer
- 'null'
examples:
- 3244
x-deprecated: true
NetworkImpressions:
type:
- integer
- 'null'
description: Impressions for authenticated accounts. This comes directly from the social platform. Social platforms - ALL. Type - Post Level/Authenticated Accounts.
examples:
- 3444
x-deprecated: true
NetworkViews_next:
type:
- integer
- 'null'
description: 'Impressions for authenticated accounts. This comes directly from the social platform. Social platforms - ALL. Type - Post Level/Authenticated Accounts.
> **Warning**: The **NetworkImpressions** field will be deprecated soon. Use this field instead of it.
'
examples:
- 3444
EngagementRate:
type:
- number
- 'null'
description: "Value calculated based on the formula `TotalEngagements / BaseMetricValue`. \nThe value is computed depending on the `BaseMetric` (followers, impressions, reach, etc.) configured within the Campaign Settings. Social platforms - ALL. Type - Post Level.\n"
format: float
examples:
- 0.034
LinkClicks:
type:
- integer
- 'null'
description: The number of clicks from a creator’s link. Type - Campaign metrics
examples:
- 10
SocialMediaValue:
type:
- integer
- 'null'
examples:
- 34344
EstimatedReachFlag:
type: integer
enum:
- 0
- 1
- null
description: Value `1` indicates if the `EstimatedReach` is used as the `Reach` value.
examples:
- 0
EstimatedImpressionsFlag:
type: integer
enum:
- 0
- 1
- null
description: Value `1` indicates if the `EstimatedImpressions` is used as the value of the `Impressions` metric.
examples:
- 0
x-deprecated: true
EstimatedViewsFlag_next:
type: integer
enum:
- 0
- 1
- null
description: 'Value `1` indicates if the `EstimatedImpressions` is used as the value of the `Impressions` metric.
> **Warning**: The **EstimatedImpressionsFlag** field will be deprecated soon. Use this field instead of it.
'
examples:
- 0
BaseMetricValue:
type:
- integer
- 'null'
description: Value of the `BaseMetric` used to calculate the Engagement Rate.
examples:
- 34344
Replies:
type:
- integer
- 'null'
description: Messages sent in reply to a story. Social platforms - Instagram. Type - Post Level/Authenticated Accounts.
examples:
- 9
Exits:
type:
- integer
- 'null'
description: Times a user stopped watching a story entirely. Social platforms - Instagram. Type - Post Level/Authenticated Accounts.
examples:
- 2
TapsForward:
type:
- integer
- 'null'
description: Times the audience tapped forward to go to the next story of the same creator. Social platforms - Instagram. Type - Post Level/Authenticated Accounts.
examples:
- 34
TapsBack:
type:
- integer
- 'null'
description: Times your audience tapped back to replay a story. Social platforms - Instagram. Type - Post Level/Authenticated Accounts.
examples:
- 3
SwipeAways:
type:
- integer
- 'null'
description: Times audience swiped right to next user’s story. Social platforms - Instagram. Type - Post Level/Authenticated Accounts.
examples:
- 3
SwipeUps:
type:
- integer
- 'null'
description: Times audience clicked on stickers that link to an external URL. Social platforms - Instagram. Type - Post Level/Authenticated Accounts.
examples:
- 34
StickerTaps:
type:
- integer
- 'null'
description: Interactions with stickers such as geotags or hashtags. Social platforms - Instagram. Type - Post Level/Authenticated Accounts.
default: null
examples:
- 34
Saves:
type:
- integer
- 'null'
description: The number of times the post was saved. Social platforms - Instagram. Type - Post Level.
default: null
examples:
- 23
InstagramShares:
type:
- integer
- 'null'
description: Total Instagram shares. Social platforms - Instagram. Type - Post Level.
examples:
- 100
ProfileVisits:
type:
- integer
- 'null'
description: Total count of profile visitors. Social platforms - Instagram. Type - Post Level.
examples:
- 100
Follows:
type:
- integer
- 'null'
description: Count of Instagram followers. Social platforms - Instagram. Type - Post Level.
examples:
- 100
Clicks:
type:
- integer
- 'null'
description: Number of times the post was clicked. Social platforms - Instagram,TikTok,Facebook,Twitter,Pinterest. Type - Post Level.
examples:
- 34
CloseUps:
type:
- integer
- 'null'
description: Times people viewed a close-up version of your Pin. Social platforms - Pinterest. Type - Post Level.
examples:
- 34
Votes:
type:
- integer
- 'null'
description: Times your audience participated in a poll. Social platforms - Instagram. Type - Post Level.
examples:
- 2
AvgStreamConcurrentViews:
type:
- number
- 'null'
description: Average number of people tuning in at the same time, taken at regular intervals and averaged out across the duration of the stream. Social platforms - Twitch. Type - Post Level.
format: float
examples:
- 2.34
PeakStreamConcurrentViews:
type:
- integer
- 'null'
description: Maximum number of people tuning in at the same time during the stream. Social platforms - Twitch. Type - Post Level.
examples:
- 344
IGBaseMetricValue:
type:
- integer
- 'null'
description: Instagram base metric value. Social platforms - Instagram. Type - Post Level.
examples:
- 2346
IGEngagement:
type:
- integer
- 'null'
description: Instagram Engagement. Social platforms - Instagram. Type - Post Level.
examples:
- 76
IGCombinedEngagement:
type:
- integer
- 'null'
description: Instagram Combined Engagement. Social platforms - Instagram. Type - Post Level.
examples:
- 76
IGPaidEngagement:
type:
- integer
- 'null'
description: Instagram Paid Engagement. Social platforms - Instagram. Type - Post Level.
examples:
- 20
IGCombinedBaseMetricValue:
type:
- integer
- 'null'
description: Instagram combined base metric value. Social platforms - Instagram. Type - Post Level.
examples:
- 2346
IGPaidBaseMetricValue:
type:
- integer
- 'null'
description: Instagram paid base metric value. Social platforms - Instagram. Type - Post Level.
examples:
- 1
EstimatedImpressions:
type:
- integer
- 'null'
description: "Estimated value of impressions is calculated using the impressions multiplier (from the network or campaign settings) multiplied by the `FollowersAtTimeOfPost`. \nThis value is populated if the `Impressions` metric is unavailable because the social account is not authenticated, and no value is entered manually. \nFor example, if a FollowersAtTimeOfPost is 100, and the impressions multiplier is 10%, their `EstimatedImpressions` would be 10. \nFor Twitch, YouTube and Tiktok, we, by default, use the `VideoViews` metric instead of `FollowersAtTimeOfPost`.\n"
examples:
- 234
x-deprecated: true
EstimatedViews_next:
type:
- integer
- 'null'
description: "Estimated value of impressions is calculated using the impressions multiplier (from the network or campaign settings) multiplied by the `FollowersAtTimeOfPost`. \nThis value is populated if the `Impressions` metric is unavailable because the social account is not authenticated, and no value is entered manually. \nFor example, if a FollowersAtTimeOfPost is 100, and the impressions multiplier is 10%, their `EstimatedImpressions` would be 10. \nFor Twitch, YouTube and Tiktok, we, by default, use the `VideoViews` metric instead of `FollowersAtTimeOfPost`.\n> **Warning**: The **EstimatedImpressions** field will be deprecated soon. Use this field instead of it.\n"
examples:
- 234
EstimatedReach:
type:
- integer
- 'null'
description: 'Estimated value of reach calculated using the reach multiplier (from the network or campaign settings) multiplied by the `FollowersAtTimeOfPost`.
This value is populated if the `Reach` is unavailable because the social account is not authenticated, and no value is entered manually.
For Twitch, YouTube and Tiktok, we, by default, use the `VideoViews` metric instead of `FollowersAtTimeOfPost`. Social platforms - Instagram, TikTok, Facebook, Twitter, Blog. Type - Post Level
'
examples:
- 3434
PaidMediaStats:
type:
- object
- 'null'
description: Сombined metrics on the posts that are in the current iteration
properties:
CombinedBaseMetricValue:
type: integer
description: Combined base metric value
examples:
- 1845846
CombinedClicks:
type: integer
description: Combined clicks count
examples:
- 2
CombinedComments:
type: integer
description: Combined comments count
examples:
- 33
CombinedEngagement:
type: integer
description: Combined Engagement
examples:
- 1050
CombinedImpressions:
type: integer
description: Combined impressions
examples:
- 815340
CombinedLikes:
type: integer
description: Combined likes count
examples:
- 1009
CombinedReach:
type: integer
description: Combined reach
examples:
- 2590716
CombinedSaves:
type: integer
description: Combined saves count
examples:
- 3
CombinedTotalShares:
type: integer
description: Combined total shares count
examples:
- 8
CombinedViews:
type: integer
description: Combined views count
examples:
- 1515
PaidPosts:
type: integer
description: Paid posts
examples:
- 0
PaidLikes:
type: integer
description: Paid likes count
examples:
- 4
PaidImpressions:
type: integer
description: Paid impressions count
examples:
- 115949
PaidReach:
type: integer
description: Paid reach count
examples:
- 84570
PaidEngagement:
type: integer
description: Paid engagement count
examples:
- 3460
PaidClicks:
type: integer
description: Paid clicks count
examples:
- 3776
PaidLinkClicks:
type: integer
description: Paid Link clicks count
examples:
- 1583
PaidViews:
type: integer
description: Paid views count
examples:
- 1583
PaidComments:
type: integer
description: PaidComments
examples:
- 47
PaidTotalShares:
type: integer
description: PaidTotalShares
examples:
- 18
PaidSaves:
type: integer
description: PaidSaves
examples:
- 13
PaidUniqueReactions:
type: integer
description: PaidUniqueReactions
examples:
- 1
PaidUniqueComments:
type: integer
description: PaidUniqueComments
examples:
- 4
PaidUniqueClicks:
type: integer
description: PaidUniqueClicks
examples:
- 4
PaidUniqueLinkClicks:
type: integer
description: PaidUniqueLinkClicks
examples:
- 5
PaidUniqueEngagements:
type: integer
description: PaidUniqueEngagements
examples:
- 6
PaidUniqueShares:
type: integer
description: PaidUniqueShares
examples:
- 7
PaidOffsiteConversions:
type: integer
description: PaidOffsiteConversions
examples:
- 8
PaidOnsiteConversions:
type: integer
description: PaidOnsiteConversions
examples:
- 9
PaidRelevanceScore:
type: integer
description: PaidRelevanceScore
examples:
- 10
PaidSpend:
type: number
description: PaidSpend
examples:
- 482.759
PaidFrequency:
type: number
description: PaidFrequency
examples:
- 1.37
PaidCTR:
type: number
description: PaidCTR
examples:
- 0.03256
PaidCPC:
type: number
description: PaidCPC
examples:
- 0.1278
PaidCPP:
type: number
description: PaidCPP
examples:
- 0.3
PaidCPM:
type: number
description: PaidCPM
examples:
- 4.16355
PaidAdRecallers:
type: number
description: PaidAdRecallers
examples:
- 4.16355
PaidAdRecallRate:
type: number
description: PaidAdRecallRate
examples:
- 4.16355
PaidBaseMetricValue:
type: number
description: PaidBaseMetricValue
examples:
- 4.16355
PaidEngagementRate:
type: number
description: PaidEngagementRate
examples:
- 4.16355
CombinedEngagementRate:
type: number
description: CombinedEngagementRate
examples:
- 4.16355
PaidCurrency:
type: string
description: PaidCurrency
examples:
- USD
PaidObjective:
type: string
description: PaidObjective
examples:
- WEB_CONVERSIONS
Posts:
type:
- integer
- 'null'
description: Total count of posts. Social platforms - Instagram. Type - Account level
examples:
- 20
required:
- totals
required:
- type
- href
- CampaignActivity
CampaignScheduledPostsSuccessResponseModel:
type: object
properties:
type:
const: ScheduledPostsCollection
description: Type of Search
examples:
- ScheduledPostsCollection
href:
type: string
description: CreatorIQ API URL to get creator's instagram timeline
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/123455/scheduledPosts?key=Id
count:
type: integer
description: Number of records in current response
default: 20
examples:
- 20
total:
type: integer
description: Total number of found rows
examples:
- 100
page:
type: integer
description: Current page
default: 1
examples:
- 1
ScheduledPostsCollection:
type: array
description: List of Scheduled Posts
items:
type: object
properties:
type:
const: ScheduledPost
examples:
- ScheduledPost
ScheduledPost:
$ref: '#/components/schemas/ScheduledPostModel'
required:
- type
- ScheduledPost
required:
- type
- href
- count
- total
- ScheduledPostsCollection
ExpenseCollectionSuccessResponseModel:
type: object
description: Success
properties:
type:
const: ExpenseCollection
description: Type of Search
examples:
- ExpenseCollection
href:
type: string
description: CreatorIQ API URL to get campaign expenses collection
examples:
- https://apis.creatoriq.com/crm/v1/api/campaign/841428/expenses
count:
type: integer
description: Number of records in current response
examples:
- 10
total:
type: integer
description: Total number of found rows
examples:
- 100
page:
type: integer
description: Current page
examples:
- 1
ExpenceCollection:
type: array
items:
type: object
properties:
type:
const: expence
description: Type of Search
examples:
- expence
href:
type: string
description: CreatorIQ API URL to get campaign expense
examples:
- https://apis.creatoriq.com/crm/v1/api/campaign/22154/expense/90
expense:
$ref: '#/components/schemas/ExpenseModel'
required:
- type
- href
- expense
required:
- type
- ExpenceCollection
ScheduledPostModel:
type: object
description: Scheduled Post information
properties:
PostId:
type: integer
description: Unique post Id
examples:
- 15165007
PublisherId:
type: integer
description: Unique publisher id
examples:
- 8082160
SocialAccountId:
type:
- string
- 'null'
default: null
examples:
- '6829119326546723846'
CampaignId:
type: integer
description: Unique campaign id
examples:
- 42066
CompletedPostId:
type:
- integer
- 'null'
default: null
examples:
- 122323
CompletedPostUrl:
type:
- string
- 'null'
format: URI
default: null
SocialNetwork:
type: string
enum:
- Facebook
- Instagram
- YouTube
- Web
- Twitter
- Twitch
- TikTok
- Snapchat
- Pinterest
description: Social network name
examples:
- Facebook
ScheduledDateTime:
type:
- string
- 'null'
default: null
PublishBefore:
type:
- string
- 'null'
description: Should be posted before date
examples:
- '2017-09-30 00:00:00.0000000 +00:00'
ActualDateTime:
type:
- string
- 'null'
default: null
Instructions:
type: string
description: Instructions for post
default: ''
InstructionsTrigger:
type:
- integer
- 'null'
description: Equal 1 if instructions enabled
default: null
examples:
- 1
Status:
type:
- string
- 'null'
description: Current status of the post
default: null
examples:
- Not submitted
PostType:
type: string
examples:
- Video
DesiredPostCaption:
type:
- string
- 'null'
default: null
examples:
- Nice Pist
DesiredPostText:
type:
- string
- 'null'
default: null
examples:
- Lorem Ipsum
DesiredPostMediaURL:
type:
- string
- 'null'
format: URI
default: null
Payout:
type:
- number
- 'null'
format: float
default: null
LastModifiedBy:
type: string
description: Name of person who make last update
examples:
- Admin
LastUpdated:
type: string
description: Last update date
examples:
- '2022-12-27 11:32:46'
CreatedBy:
type: string
description: Name of person who create
examples:
- Admin
Approval:
type:
- string
- 'null'
default: null
SubmitByDate:
type:
- string
- 'null'
default: null
examples:
- '2022-12-11T22:00:00+00:00'
PublishAfter:
type:
- string
- 'null'
description: Should be posted after date
default: null
examples:
- '2022-12-12T22:00:00+00:00'
ContentApproval:
type: string
enum:
- Required
- Not Required
description: Name of content approval person
examples:
- Not Required
PostNote:
type:
- string
- 'null'
description: Notes of post
default: null
PostStatus:
type:
- string
- 'null'
default: null
ActualPostStatus:
type:
- string
- 'null'
default: null
SubmitBeforeDate:
type:
- string
- 'null'
description: Should be submit before date
default: null
examples:
- '2022-12-31T22:00:00+00:00'
PostContent:
type: object
description: Post information
properties:
type:
type: string
description: Type of Search
examples:
- PostContentCollection
href:
type: string
description: CreatorIQ API URL to get creator's instagram timeline
default: ''
count:
type: integer
description: Number of records in current response
default: 20
examples:
- 20
total:
type: integer
description: Total number of found rows
examples:
- 100
page:
type: integer
description: Current page
default: 1
examples:
- 1
PostContentCollection:
type: array
description: List of posts
items:
type: object
required:
- type
- href
- PostContentCollection
Description:
type:
- string
- 'null'
default: null
PaymentStatus:
type:
- string
- 'null'
default: null
PaymentStatusDate:
type:
- string
- 'null'
default: null
PaymentErrorMessage:
type:
- string
- 'null'
default: null
PaymentRejectionNote:
type:
- string
- 'null'
default: null
RequirementsCompletedAt:
type:
- string
- 'null'
default: null
PaymentTerm:
type:
- string
- 'null'
default: null
PaymentDueDate:
type:
- string
- 'null'
default: null
CampaignCode:
type:
- string
- 'null'
default: null
examples:
- 1HQLLV01B01
OrderLink:
type:
- string
- 'null'
description: An Order link
format: URI
default: null
examples:
- https://paypal.com/ORDER_LINK
YouTubeCampaignCode:
type:
- string
- 'null'
description: YouTube Brand Campaign Code
format: URI
default: null
examples:
- ABC123
Title:
type:
- string
- 'null'
description: Requirement Title - Custom requirement title
default: null
examples:
- Example Requirement Title
required:
- PostId
- PublisherId
CampaignPublishersSuccessResponseModel:
type: object
description: Used when no `publisherId` param is in query
properties:
type:
const: CampaignPublisher
description: Type of Search
examples:
- CampaignPublisher
href:
type: string
description: CreatorIQ API URL to get campaign information
examples:
- https://apis.creatoriq.com/crm/v1/campaign/42066/publishers
CampaignPublisher:
type: object
description: All publishers in Campaign as array when no `publisherId` param is in query
patternProperties:
'[0-9]+':
allOf:
- $ref: '#/components/schemas/CampaignPublisherModel'
IntegrationSettings:
$ref: '#/components/schemas/IntegrationSettingsModel'
NetworkCampaignName:
type:
- string
- 'null'
description: External campaign name
examples:
- NetworkCampaignCola
TrackingLinkCreationType:
type: 'null'
enum:
- mass-generate
- link-by-link
description: Exists only if if campaign has TrackingLinkCreationType value
CampaignFlags:
$ref: '#/components/schemas/CampaignFlagsModel'
description: Exists only when `sections` param contains `CampaignFlags`
required:
- type
- href
- CampaignPublisher
DeletePublisherFromCampaignBody:
type: object
properties:
publisherId:
type: array
description: Unique publisher id or array of publishers ids
minItems: 1
examples:
- - 8082160
- 8082161
uniqueItems: true
items:
type: integer
required:
- publisherId
ScheduledPostsSelectionModel:
type: integer
oneOf:
- type:
- integer
- 'null'
default: null
examples:
- 2
- $ref: '#/components/schemas/CampaignScheduledPostsSuccessResponseModel'
- type: array
default: []
items:
$ref: '#/components/schemas/ScheduledPostModel'
CampaignFlagsModel:
type: object
properties:
HasBudget:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasObjectives:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasCreativeBrief:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasDisclosureMonitoring:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasInviteCreators:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasRequirements:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasInstructions:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasContentApproval:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasPayout:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasLinkTracking:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasEngagementRateBase:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasContractTerms:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasPaidBoost:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasEmailTemplates:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasBrandSafety:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
CampaignVisibility:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
EarnedPostsFlag:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasPaidMedia:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasCampaignFlow:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
HasSendProducts:
type: integer
enum:
- 0
- 1
default: 0
examples:
- 1
required:
- HasBudget
AssignPublisherToCampaignSuccessResponseModel:
type: object
properties:
type:
const: CampaignPublisher
description: Type of Search
examples:
- CampaignPublisher
href:
type: string
description: CreatorIQ API URL to get campaign information
examples:
- https://apis.creatoriq.com/crm/v1/api/campaign/42066/publishers
CampaignPublisher:
type: object
properties:
CampaignId:
type: integer
description: Unique campaign id
examples:
- 42066
PublisherId:
type: integer
examples:
- 3293835
ErrorMessage:
type:
- string
- 'null'
default: null
required:
- CampaignId
required:
- type
- href
- CampaignPublisher
ListBrandSuccessResponseModel:
type: object
properties:
type:
const: BrandCollection
description: Type of collection
href:
type: string
description: CreatorIQ API URL to get advertiser info
examples:
- https://apis.creatoriq.com/crm/v1/api/brands
count:
type: integer
description: Number of records in current response
examples:
- 10
total:
type: integer
description: Total number of found rows
examples:
- 100
page:
type: integer
description: Current page
examples:
- 1
BrandCollection:
type: array
items:
type: object
properties:
type:
const: brand
examples:
- brand
href:
type: string
description: CreatorIQ API URL to get advertiser info
examples:
- https://apis.creatoriq.com/crm/v1/api/brands/50852
Brand:
type: object
properties:
BrandId:
type: integer
description: ID of the custom brand (advertiser). Use this value as `AdvertiserId` when creating or updating a campaign; do not use it as campaign `BrandId`.
examples:
- 50852
BrandName:
type: string
examples:
- Coca-Cola
Description:
type: string
examples:
- Short description of brand
CreatedBy:
type: string
examples:
- Admin
DateTimeCreated:
type: string
examples:
- 01/01/2024 09:20:40
LastModifiedBy:
type: string
examples:
- admin
LastModified:
type: string
examples:
- 01/06/2023 09:13:40
PartnerId:
type: integer
description: Unique partner id
examples:
- 21
BillingName:
type:
- string
- 'null'
examples:
- Billing Name
required:
- type
required:
- type
- href
- BrandCollection
UpdateCampaignPublisherDetailsBody:
type: object
properties:
Payout:
type:
- string
- 'null'
default: null
x-deprecated: true
PayoutType:
type:
- string
- 'null'
default: null
x-deprecated: true
RequiredPostsYouTube:
type:
- integer
- 'null'
description: Number of required post on YouTube
examples:
- 10
PlatformYouTube:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if YouTube enabled or disabled * 0 or null YouTube disabled for Campaign * 1 YouTube enabled for Campaign
RequiredPostsFacebook:
type: integer
description: Number of required post on Facebook
examples:
- 10
PlatformFacebook:
type: integer
enum:
- 0
- 1
description: Flag represents if Facebook enabled or disabled * 0 or null Facebook disabled for Campaign * 1 Facebook enabled for Campaign
RequiredPostsTwitter:
type: integer
description: Number of required post on Twitter
examples:
- 10
PlatformTwitter:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Twitter enabled or disabled * 0 or null Twitter disabled for Campaign * 1 Twitter enabled for Campaign
RequiredPostsInstagram:
type: integer
description: Number of required post on Instagram
examples:
- 10
PlatformInstagram:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Instagram enabled or disabled * 0 or null Instagram disabled for Campaign * 1 Instagram enabled for Campaign
RequiredPostsPinterest:
type: integer
description: Number of required post on Pinterest
examples:
- 10
PlatformPinterest:
type: integer
enum:
- 0
- 1
description: Flag represents if Pinterest enabled or disabled * 0 or null Pinterest disabled for Campaign * 1 Pinterest enabled for Campaign
RequiredPostsTwitch:
type:
- integer
- 'null'
description: Number of required post on Twitch
examples:
- 10
PlatformTwitch:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Twitch enabled or disabled * 0 or null Twitch disabled for Campaign * 1 Twitch enabled for Campaign
RequiredPostsTumblr:
type:
- integer
- 'null'
description: Number of required post on Tumblr
examples:
- 10
PlatformTumblr:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Tumblr enabled or disabled * 0 or null Tumblr disabled for Campaign * 1 Tumblr enabled for Campaign
RequiredPostsSnapchat:
type:
- integer
- 'null'
description: Number of required post on Snapchat
examples:
- 10
PlatformSnapchat:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Snapchat enabled or disabled * 0 or null Snapchat disabled for Campaign * 1 Snapchat enabled for Campaign
RequiredPostsTikTok:
type:
- integer
- 'null'
description: Number of required post on TikTok
examples:
- 10
PlatformTikTok:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if TikTok enabled or disabled * 0 or null TikTok disabled for Campaign * 1 TikTok enabled for Campaign
RequiredPostsWeb:
type:
- integer
- 'null'
description: Number of required post on Web
examples:
- 10
PlatformWeb:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Web enabled or disabled * 0 or null Web disabled for Campaign * 1 Web enabled for Campaign
default: 0
Note:
type:
- string
- 'null'
default: null
RespondByDate:
type: string
examples:
- 12/27/2022 14:08:31
DateRequirementsCompleted:
type: string
examples:
- 12/27/2022 14:08:31
minProperties: 1
CreateCampaignActivitySuccessResponseModel:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- SponsoredPost
href:
type: string
description: CreatorIQ API URL to campaign scheduled posts
examples:
- https://apis.creatoriq.com/crm/v1/api/data/sponsored/20829024
SponsoredPost:
$ref: '#/components/schemas/CampaignActivityModel'
required:
- type
- href
- SponsoredPost
CreateAdvertiserBrandBody:
type: object
description: Schema represens request for create advertiser
properties:
BrandName:
type: string
examples:
- Coca Cola
BillingName:
type: string
examples:
- Test
Description:
type: string
examples:
- Short description
required:
- BrandName
minProperties: 1
ErrorResponseModel:
type: object
description: Exception
properties:
type:
type: string
description: Exception type
examples:
- CoreException
CoreException:
type: object
description: Exception information
properties:
code:
type: integer
description: Exception status code
format: int32
examples:
- 404
message:
type: string
description: Exception message
examples:
- Supplied ID was not found
required:
- type
CreateCampaignActivityBody:
type: object
properties:
link:
type: string
description: Url to social network post
examples:
- https://www.instagram.com/reel/CmMnORXJRuA
SocialNetwork:
type: string
description: Social network name
examples:
- instagram
SocialNetworkId:
type: string
examples:
- ''
PostType:
type: string
enum:
- video
- image
description: Post type
examples:
- video
user:
type: string
description: User username
examples:
- therock
Thumbnail:
type: string
description: url to post thumbnail
examples:
- https://static-resources.creatoriq.com/social-pictures/instagram/thumbnail/CmMnORXJRuA.jpg
SavedPicture:
type: string
description: url to post saved picture
examples:
- https://static-resources.creatoriq.com/social-pictures/instagram/thumbnail/CmMnORXJRuA.jpg
minProperties: 1
AssignPublisherToCampaignBody:
type: object
properties:
publisherId:
type: integer
description: Unique publishers id
oneOf:
- type: integer
examples:
- 2323
- type: array
items:
type: integer
examples:
- 2334
status:
type: string
description: Status of publisher in campaign
examples:
- Accepted
required:
- publisherId
- status
Brand:
type: object
title: Brand
properties:
brandId:
type: integer
description: V2 brand ID. Use this value as `BrandId` when creating or updating a campaign.
examples:
- 12143
name:
type: string
description: Name of the global brand
examples:
- Nike
globalBrandId:
type: integer
description: CreatorIQ global brand identifier
examples:
- 1002286
required:
- brandId
- name
- globalBrandId
responses:
AdvertiserBrandSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdvertiserBrandSuccessResponseModel'
CampaignInformationSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignModel'
AuthErrorResponse:
description: Incorrect x-api-key
CreateAdvertiserBrandSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAdvertiserBrandSuccessResponseModel'
CampaignDailyStatsSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignDailyStatsSuccessResponseModel'
CreateCampaignActivitySuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCampaignActivitySuccessResponseModel'
CampaignActivitySuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignActivitySuccessResponseModel'
CreateCampaignSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignModel'
AssignPublisherToCampaignSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssignPublisherToCampaignSuccessResponseModel'
ExpenseSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ExpenseSuccessResponseModel'
UpdateActivityAsyncSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateActivityAsyncSuccessResponseModel'
ErrorResponse400:
description: Bad request (i.e., wrong params)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseModel'
CampaignScheduledPostsSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignScheduledPostsSuccessResponseModel'
CampaignPublishersResponse:
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/CampaignPublishersSuccessResponseModel'
- $ref: '#/components/schemas/CampaignPublishersSinglePublisherSuccessResponseModel'
ListBrandSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListBrandSuccessResponseModel'
GeneralErrorResponse:
description: Something went wrong
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseModel'
CampaignsListSuccessResponse:
description: List of campaigns
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignsSuccessResponseModel'
ErrorResponse404:
description: Campaign with supplied ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseModel'
CampaignPublishersListSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignPublishersListSuccessResponseModel'
AdditionalRequirementsSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalRequirementsSuccessModel'
ExpenseCollectionSuccessResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ExpenseCollectionSuccessResponseModel'
'204':
description: The empty request when no brands not associated with partner
'404':
description: Brand not found.
'403':
description: Access was denied due to the API due to insufficient access permissions.
'401':
description: The request could not be completed due to invalid API credentials
securitySchemes:
apiKey:
type: apiKey
name: x-api-key
in: header
x-refined-from:
- creatoriq-campaigns-openapi.yml
- creatoriq-v2-campaigns-openapi.yml