openapi: 3.0.1
info:
version: 1.0.0
title: CreatorIQ Reporting APIs
description: |
This is reporting async API
termsOfService: 'https://www.creatoriq.com/legal/terms-of-use'
contact:
name: CreatorIQ
url: 'https://www.creatoriq.com'
email: support@creatoriq.com
license:
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
name: Apache 2.0
servers:
- url: 'https://apis.creatoriq.com'
description: Live
paths:
/crm/v1/api/view?view=Reports/Campaigns/CampaignPosts:
get:
tags:
- Reporting
summary: Get campaign post statistics
description: |
Your report will be stored at Result => Headers => Location url when status task is DONE
operationId: getCampaignPosts
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/section'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: |
Field for sorting can be sorted by
* CampaignName
* Comments
* Likes
* SocialNetwork
* Reach
* PublisherName
* FlagshipPropertyTitle : represents primary account
schema:
type: string
enum:
- CampaignName
- Comments
- Likes
- SocialNetwork
- Reach
- PublisherName
- FlagshipPropertyTitle
example: CampaignName
examples:
default:
value: CampaignName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignPostReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/Campaigns/CampaignsSummary:
get:
tags:
- Reporting
summary: Get campaign summary report
description: 'Get statistics for all campaigns like number of creators, number of posts by campaign'
operationId: getSummaryReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/section'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: |
Can sort by
* CampaignId
* CampaignName
* YTPosts: count of Youtube posts
schema:
type: string
enum:
- CampaignId
- CampaignName
- YTPosts
example: CampaignId
examples:
default:
value: CampaignId
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignSummaryReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/Campaigns/CampaignsTopInfluencers:
get:
tags:
- Reporting
summary: Get campaigns top creators
description: Fetch top influencers by all campaigns
operationId: getCampaignsTopInfluencers
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/section'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: |
Top influencers can by sorted by
* NumOfPosts: number of posts
* TotalSubscribers: number of subscribers
schema:
type: string
enum:
- NumOfPosts
- TotalSubscribers
example: NumOfPosts
examples:
default:
value: NumOfPosts
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignTopInfluencers'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/Campaigns/CampaignPublishers:
get:
tags:
- Reporting
summary: Get Campaign publishers report
description: Fetch info for publishers in campaigns
operationId: getCampaignPublishersReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/section'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: |
Publishers field for sort
* FlagshipPropertyTitle: Sort by primary account
schema:
type: string
enum:
- CampaignName
- CampaignId
- CampaignStatus
- PublisherName
- FlagshipPropertyTitle
example: CampaignName
examples:
default:
value: CampaignName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignPublishers'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/Campaigns/CampaignVideos:
get:
tags:
- Reporting
summary: Get videos views for all campaign videos
description: 'Fetch video statistics by campaign like views, video title, creator'
operationId: getCampaignVideos
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/section'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: |
Publishers field for sort
* FlagshipPropertyTitle: Sort by primary account
* Post : sort by video title
* DateSubmittedF : sort by DateUploaded time
schema:
type: string
enum:
- CampaignName
- CampaignId
- PublisherName
- FlagshipPropertyTitle
- Post
- Views
- DateSubmitted
example: CampaignName
examples:
default:
value: CampaignName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignVideos'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/InstagramCampaignPosts:
get:
tags:
- Reporting
summary: Get Instagram campaign posts statistics
description: Fetch Instagram posts statistics by campaign
operationId: getInstagramPostsStatistics
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/section'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/month'
- $ref: '#/components/parameters/year'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sort
schema:
type: string
enum:
- PublisherName
- CampaignName
- SocialHandle
- PostDate
- Followers
- BrandName
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/instagramCampaignPosts'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/InstagramWeeklyCampaignUpdates:
get:
tags:
- Reporting
summary: Get Instagram weekly updates
description: Fetch all posts which updated in campaigns last week
operationId: getInstagramWeeklyVideos
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: |
Fields for sort
* WeekNum: Date start of the week when calculated metrics delta
schema:
type: string
enum:
- PublisherName
- WeekNum
- CampaignName
- PostLink
- BrandName
- PostType
- PostDate
- PostStatus
- Likes
- Impressions
- Comments
- Reach
- Saved
- SMV
- Followers
example: WeekNum
examples:
default:
value: WeekNum
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/instagramWeeklyCampaignUpdatesReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/YoutubeCampaignPosts:
get:
tags:
- Reporting
summary: Get info for youtube campaign posts
description: Fetch statistics for youtube campaign posts
operationId: getYoutubeCampaignPosts
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sort
schema:
type: string
enum:
- PublisherName
- SocialHandle
- CampaignName
- BrandName
- PostLink
- PostDate
- PostTitle
- SMV
- Views
- Engagement
- Followers
example: SocialHandle
examples:
default:
value: SocialHandle
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/youtubeCampaignPosts'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/YoutubeWeeklyCampaignUpdates:
get:
tags:
- Reporting
summary: Get youtube weekly campaign updates
description: Statistic for youtube post in all campaigns in one week
operationId: getYoutubeWeeklyCampaignUpdates
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sort
schema:
type: string
enum:
- PublisherName
- WeekNum
- CampaignName
- BrandName
- PostLink
- PostDate
- PostTitle
- SMV
- Views
- Engagement
- Followers
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/youtubeWeeklyCampaignUpdates'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/FollowerFraudAudit/Summary:
get:
tags:
- Reporting
summary: Get fraud statistics for publishers
description: Get fraud statistics for publishers in all campaigns
operationId: getFraudSummary
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sort
schema:
type: string
enum:
- PublisherName
- Followers
- Status
- StatusCategory
- TotalFraudFlags
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/followerFraudAuditSummary'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CreatorsPaymentCollectionStatusDetails:
get:
tags:
- Reporting
summary: Get creator's payment info collection status
description: Get all Creator's Payment Info Collection
operationId: getCreatorsPaymentCollectionStatusDetails
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sort
schema:
type: string
enum:
- PublisherName
- Followers
- Status
- StatusCategory
- TotalFraudFlags
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/creatorsPaymentStatusDetails'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/FollowerFraudAudit/GrowthRate:
get:
tags:
- Reporting
summary: Get GrowthRate for creators
description: Fetch GrowthRate for all publishers
operationId: getGrowsRateSummary
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sort
schema:
type: string
enum:
- PublisherName
- NetworkUser
- StatDateYear
- StatDateMonth
- Followers
- PrevMonthFollowers
- GrowthRatePercentage
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/growthRate'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/FollowerFraudAudit/EngagementRate:
get:
tags:
- Reporting
summary: Get EngagementRate for publishers
description: Fetch EngagementRate for all publishers
operationId: getEngagementRate
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: |
Field for sort
* NetworkUser: Social handle
* AVGLowEngagement: Average value for engagement rate for period
* MedianEngagement: median value for ER for period
schema:
type: string
enum:
- PublisherName
- NetworkUser
- EngagementRate
- AVGLowEngagement
- MedianEngagement
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/engagementRate'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/LinkedAccountsByNetwork/BrokenLinks:
get:
tags:
- Reporting
summary: Get broken links with linked account
description: Fetch broken links with all linked accounts
operationId: getBrokenLinks
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- AccountHandle
- PublisherName
- Network
- DateInviteLinkSent
- DateBroken
- DateLinked
- LinkingStatus
- CreatorEmail
example: AccountHandle
examples:
default:
value: AccountHandle
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/brokenLinks'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/LinkedAccounts/LinkedAccountsReport:
get:
tags:
- Reporting
summary: Get linked accounts
description: Fetch linked accounts
operationId: getLinkedAccounts
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
- Network
- Handle
- LinkingStatus
- DateInviteLinkSent
- DateLinked
- DateBroken
example: Handle
examples:
default:
value: Handle
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/linkedAccounts'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/LinkedAccountsByNetwork/LinkedAccounts:
get:
tags:
- Reporting
summary: Get all linked account
description: Fetch broken links with all linked accounts
operationId: getAllLinkedAccounts
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- AccountHandle
- PublisherId
- PublisherName
- CreatorName
- Network
- LinkingStatus
- ManagementCompany
- AgentName
- AgentEmail
- DateInviteLinkSent
- DateLinked
- DateBroken
example: AccountHandle
examples:
default:
value: AccountHandle
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/allLinkedAccounts'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/LinkedAccountsByNetwork/NonLinkedAccounts:
get:
tags:
- Reporting
summary: Get non-linked accounts
description: Fetch non-linked accounts
operationId: getNonLinkedAccounts
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
- Network
- AccountHandle
- CreatorEmail
- ManagementCompany
- DateInviteLinkSent
- AgentName
- AgentEmail
example: AccountHandle
examples:
default:
value: AccountHandle
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/nonLinkedAccounts'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CreatorPaymentsReport:
get:
tags:
- Reporting
summary: Get Creator Payments
description: Fetch Creator Payments
operationId: getCreatorPayments
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
- Network
- AccountHandle
- CreatorEmail
- ManagementCompany
- DateInviteLinkSent
- AgentName
- AgentEmail
example: AccountHandle
examples:
default:
value: AccountHandle
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/creatorPayments'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/CampaignsPosts:
get:
tags:
- Reporting
summary: Get Campaigns Posts Statistics
description: Fetch Campaigns Posts Statistics
operationId: getCampaignsPosts
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- CampaignId
- CampaignName
- PublisherId
- PublisherName
- SocialNetwork
example: PublisherId
examples:
default:
value: PublisherId
- name: 'requestData[params][Year]'
in: query
description: Year for which need to collect the data (should be always present and empty if you want to collect data for all time)
required: true
schema:
type: integer
example: 2024
examples:
default:
value: 2024
- name: 'requestData[params][Month]'
in: query
description: Month for which need to collect the data (should be always present and empty if you want to collect data for year or for all time)
required: true
schema:
type: integer
example: 10
examples:
default:
value: 10
- name: 'requestData[params][isAll]'
in: query
description: Flag to collect all data. Should be present for collect data for all time.
schema:
type: boolean
enum:
- true
- false
example: true
examples:
default:
value: true
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignsPosts'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/Campaigns/CampaignMessaging:
get:
tags:
- Reporting
summary: Get Campaign Messaging
description: Fetch Campaign Messaging
operationId: getCampaignMessaging
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/month'
- $ref: '#/components/parameters/year'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- EmailSentDate
- CampaignId
- CampaignName
- PublisherID
- PublisherName
example: EmailSentDate
examples:
default:
value: EmailSentDate
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignMessaging'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/ReachReport:
get:
tags:
- Reporting
summary: Get Reach Report
description: Fetch Reach Report
operationId: getReachReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/reachReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/Campaigns:
get:
tags:
- Reporting
summary: Get Campaigns Report
description: Fetch Campaigns Report
operationId: getCampaignsReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignsByNetworkReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/CampaignWeeklyUpdates:
get:
tags:
- Reporting
summary: Get Campaign Weekly Updates Report
description: Fetch Campaign Weekly Updates Report
operationId: getCampaignWeeklyUpdatesReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/campaignWeeklyUpdatesReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/FacebookWeeklyCampaignUpdates:
get:
tags:
- Reporting
summary: Get Facebook Weekly Campaign Updates Report
description: Fetch Facebook Weekly Campaign Updates Report
operationId: getFacebookWeeklyCampaignUpdatesReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/facebookWeeklyCampaignUpdatesReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/TwitterCampaignPosts:
get:
tags:
- Reporting
summary: Get Twitter Campaign Posts Report
description: Fetch Twitter Campaign Posts Report
operationId: getTwitterCampaignPostsReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/twitterCampaignPostsReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/TwitterWeeklyCampaignUpdates:
get:
tags:
- Reporting
summary: Get Twitter Weekly Campaign Updates Report
description: Fetch Twitter Weekly Campaign Updates Report
operationId: getTwitterWeeklyCampaignUpdatesReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/twitterWeeklyCampaignUpdatesReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/PinterestCampaignPosts:
get:
tags:
- Reporting
summary: Get Pinterest Campaign Posts Report
description: Fetch Pinterest Campaign Posts Report
operationId: getPinterestCampaignPostsReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/pinterestCampaignPostsReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/PinterestWeeklyCampaignUpdates:
get:
tags:
- Reporting
summary: Get Pinterest Weekly Campaign Updates Report
description: Fetch Pinterest Weekly Campaign Updates Report
operationId: getPinterestWeeklyCampaignUpdatesReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/pinterestWeeklyCampaignUpdatesReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/TwitchCampaignPosts:
get:
tags:
- Reporting
summary: Get Twitch Campaign Posts Report
description: Fetch Twitch Campaign Posts Report
operationId: getTwitchCampaignPostsReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/twitchCampaignPostsReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CampaignsByNetwork/TwitchWeeklyCampaignUpdates:
get:
tags:
- Reporting
summary: Get Twitch Weekly Campaign Updates Report
description: Fetch Twitch Weekly Campaign Updates Report
operationId: getTwitchWeeklyCampaignUpdatesReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/skip'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
- name: 'requestData[params][PartnerId]'
in: query
description: Partner Id
schema:
type: integer
example: 11
examples:
default:
value: 11
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/twitchWeeklyCampaignUpdatesReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/Channels:
get:
tags:
- General
summary: YouTube Channel Report
description: YouTube channel report for all publishers in the CRM
operationId: getYoutubeChannelReport
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/channelReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CreatorContactInfo:
get:
tags:
- General
summary: Get Creator Contact Info Report
description: Fetch Creator Contacts
operationId: getCreatorContactInfoReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherId
- PublisherName
example: PublisherId
examples:
default:
value: PublisherId
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/creatorContactInfoReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/ImportTemplateReport:
get:
tags:
- General
summary: Get Import Template Report
description: 'Import template containing creator information including social handles, name and ID for all creators in the CRM'
operationId: getImportTemplateReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherName
example: PublisherName
examples:
default:
value: PublisherName
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/importTemplateReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/DailyCampaignPosts:
get:
tags:
- General
summary: Get Daily Campaign Posts Report
description: Fetch Daily Campaign Posts
operationId: getDailyCampaignPosts
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- campaignId
example: campaignId
examples:
default:
value: campaignId
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/dailyCampaignPosts'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CreatorPromoteReport:
get:
tags:
- General
summary: Get Creator Promote Report
description: Fetch Creator Promote
operationId: getCreatorPromote
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- DatePermissionsGranted
- PublisherName
- PublisherId
- SocialNetwork
example: DatePermissionsGranted
examples:
default:
value: DatePermissionsGranted
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/creatorPromote'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CreatorsReport:
get:
tags:
- General
summary: Get Creators Report
description: Fetch report about creators
operationId: getCreatorsReport
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- publisherid
- publishername
example: publisherid
examples:
default:
value: publisherid
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/creatorsReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CreatorConnectCreators:
get:
tags:
- General
summary: Get Creator Connect Report
description: Fetch report for all the creators in the CRM that were added via Creator Connect
operationId: getCreatorConnect
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherName
- PublisherId
- SocialNetwork
example: PublisherId
examples:
default:
value: PublisherId
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/creatorConnect'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/Publishers:
get:
tags:
- General
summary: Get Publishers Report
description: Fetch Publishers
operationId: getPublishersList
parameters:
- $ref: '#/components/parameters/dir'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/section'
- name: 'requestData[sort][0][field]'
in: query
description: Field for sorting
schema:
type: string
enum:
- PublisherName
- PublisherId
- SocialNetwork
example: PublisherId
examples:
default:
value: PublisherId
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/publishersList'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=OneSheetBuilder/OneSheetBuilder:
get:
tags:
- OneSheet
summary: Get OneSheet Builder
description: Fetch OneSheet Publishers
operationId: getOneSheetBuilder
parameters:
- $ref: '#/components/parameters/section'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/dir'
- name: 'requestData[sort][0][field]'
in: query
description: |
Field for sorting can be sorted by
* SortOrder
* PublisherName
* TotalSubscribers
* CreatedAt
* UpdatedAt
* FlagshipSocialNetwork : represents primary social network
* FlagshipPropertyTitle : represents primary account
schema:
type: string
enum:
- SortOrder
- PublisherName
- TotalSubscribers
- CreatedAt
- UpdatedAt
- FlagshipSocialNetwork
- FlagshipPropertyTitle
example: SortOrder
examples:
default:
value: SortOrder
- name: 'requestData[sort][0][name]'
in: query
description: |
Sorting field name
* SortOrder
* PublisherName
* TotalSubscribers
* CreatedAt
* UpdatedAt
* FlagshipSocialNetwork
* FlagshipPropertyTitle
schema:
type: string
enum:
- SortOrder
- PublisherName
- TotalSubscribers
- CreatedAt
- UpdatedAt
- FlagshipSocialNetwork
- FlagshipPropertyTitle
example: SortOrder
examples:
default:
value: SortOrder
- name: 'requestData[params][SalesSheetId]'
in: query
description: OneSheet ID
schema:
type: integer
example: 757214
examples:
default:
value: 757214
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/oneSheetBuilder'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
/crm/v1/api/view?view=Reports/CJAccountsReport:
get:
tags:
- CJ
summary: CJ Accounts Report
description: CJ Accounts Report
operationId: getCJAccountsReport
parameters:
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/skip'
responses:
'200':
$ref: '#/components/responses/asyncResponse'
Result:
$ref: '#/components/responses/CJAccountsReport'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
tags:
- name: CJ
description: CJ reports
- name: General
description: General section of reporting
- name: OneSheet
description: OneSheets reporting
- name: Reporting
description: Reporting
components:
parameters:
dir:
name: 'requestData[sort][0][dir]'
in: query
description: Sorting
schema:
type: string
enum:
- asc
- desc
example: asc
examples:
default:
value: asc
section:
name: section
in: query
description: Default section
schema:
type: string
enum:
- default
example: default
examples:
default:
value: default
take:
name: 'requestData[take]'
in: query
description: Number of rows to fetch
required: true
schema:
type: integer
example: 20
examples:
default:
value: 20
skip:
name: 'requestData[skip]'
in: query
description: Number of rows to skip
schema:
type: integer
example: 0
examples:
default:
value: 0
page:
name: 'requestData[page]'
in: query
description: Current page
schema:
type: integer
minimum: 1
example: 1
examples:
default:
value: 1
pageSize:
name: 'requestData[pageSize]'
in: query
description: Size of page
schema:
type: integer
minimum: 1
example: 20
examples:
default:
value: 20
month:
name: 'requestData[params][Month]'
in: query
description: Month number for reporting
schema:
type: integer
minimum: 1
maximum: 12
example: 11
examples:
default:
value: 11
year:
name: 'requestData[params][Year]'
in: query
description: Year number for reporting
schema:
type: integer
minimum: 2014
example: 2020
examples:
default:
value: 2020
securitySchemes:
apiKey:
type: apiKey
name: x-api-key
in: header
responses:
asyncResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/generalSchema'
twitterWeeklyCampaignUpdatesReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/twitterWeeklyCampaignUpdatesSchema'
pinterestCampaignPostsReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/pinterestCampaignPostsSchema'
pinterestWeeklyCampaignUpdatesReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/pinterestWeeklyCampaignUpdatesSchema'
twitchCampaignPostsReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/twitchCampaignPostsSchema'
twitchWeeklyCampaignUpdatesReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/twitchWeeklyCampaignUpdatesSchema'
campaignsByNetworkReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignsByNetworkSchema'
campaignWeeklyUpdatesReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignWeeklyUpdatesSchema'
instagramWeeklyCampaignUpdatesReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/instagramWeeklyCampaignUpdatesSchema'
facebookWeeklyCampaignUpdatesReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/facebookWeeklyCampaignUpdatesSchema'
twitterCampaignPostsReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/twitterCampaignPostsSchema'
campaignPostReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignPostsSchema'
campaignSummaryReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignSummarySchema'
campaignTopInfluencers:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignTopInfluencersSchema'
campaignPublishers:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignPublishers'
campaignVideos:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignVideos'
instagramCampaignPosts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/instagramCampaignPosts'
youtubeCampaignPosts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/youtubeCampaignPosts'
youtubeWeeklyCampaignUpdates:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/youtubeWeeklyCampaignUpdates'
followerFraudAuditSummary:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/followerFraudAuditSummary'
creatorsPaymentStatusDetails:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/creatorsPaymentStatusDetails'
growthRate:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/growthRate'
engagementRate:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/engagementRate'
brokenLinks:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/brokenLinks'
linkedAccounts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/linkedAccounts'
allLinkedAccounts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/allLinkedAccounts'
nonLinkedAccounts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/nonLinkedAccounts'
creatorPayments:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/creatorPayments'
campaignsPosts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignsPosts'
campaignMessaging:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/campaignMessaging'
reachReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/reachReport'
channelReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/channelReport'
creatorContactInfoReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/creatorContactInfoReport'
importTemplateReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/importTemplateReport'
dailyCampaignPosts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/dailyCampaignPosts'
creatorPromote:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/creatorPromote'
creatorsReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/creatorsReport'
creatorConnect:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/creatorConnect'
publishersList:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/publishersList'
oneSheetBuilder:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/oneSheetBuilder'
CJAccountsReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/CJAccountsReport'
CouponCodePayouts:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/CouponCodePayouts'
TransactionsReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsReport'
1CampaignsDetails:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/1CampaignsDetails'
InstagramFacebookReport:
description: Final result stored by **Result -> Headers -> Location** field. Available when status is **DONE**
content:
application/json:
schema:
$ref: '#/components/schemas/InstagramFacebookReport'
schemas:
generalSchema:
type: object
properties:
TaskId:
type: string
description: Unique id of report
example: 79985e5d-8871-4f38-be44-605d58f90bd9
TaskStatus:
type: string
enum:
- CREATED
- PROCESSING
- DONE
description: |
Status of request.
* CREATED: represents of new created report
* PROCESSING: your report is progress
* DONE: your report is ready. Result present in **Result => Headers => Location URL**
CreatedAtTS:
type: integer
description: Timestamp when task is created in seconds
example: 1674135497
UpdatedAtTS:
type: integer
description: Timestamp when task is updated in seconds
example: 1674135497
ExpiresAtTS:
type: integer
description: Timestamp when task is expired in seconds.
example: 1674136497
CreatedAt:
type: string
description: Date which task created in human readable format
example: '2023-01-19T13:38:17+0000'
UpdatedAt:
type: string
description: Date which task updated in human readable format
example: '2023-01-19T13:38:17+0000'
ExpiredAt:
type: string
description: Date which task updated in human readable format
example: '2023-01-19T13:38:17+0000'
Metadata:
type: object
properties:
PartnerId:
type: integer
example: 21
Gri:
type: object
description: Used for logging
ValidUntil:
type: string
example: '2023-01-19T14:08:16+0000'
ValidUntilTS:
type: integer
example: 1674137296
Result:
type: object
oneOf:
- type: object
description: If your object ready you fetch you receive 302 result
properties:
Status:
type: integer
description: Http status of response
example: 302
Body:
type: string
description: Empty string represents body of response.
example: ''
Headers:
type: object
properties:
Cache-Control:
type: string
example: max-age=7200
Date:
type: string
example: 'Thu, 19 Jan 2023 13:39:22 +0000'
Location:
type: string
description: Most important field! Result location of data
readOnly: true
example: 'https://ciq-api-async-results-data.s3.us-west-1.amazonaws.com/creatoriq-live/report.json'
required:
- Location
required:
- Status
- Headers
- type: object
description: If your report not ready empty object
required:
- TaskId
- TaskStatus
- CreatedAtTS
- UpdatedAtTS
- ExpiresAtTS
- CreatedAt
- UpdatedAt
- ExpiredAt
- Result
twitterWeeklyCampaignUpdatesSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
WeekNum:
type: string
nullable: true
description: Date start of the week when calculated metrics delta
format: date
example: '2019-04-04'
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://twitter.com/_CristianRivero/status/1531342833617084416'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: image
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Rejected
Likes:
type: integer
nullable: true
description: Likes
default: null
example: 17
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
Impressions:
type: integer
nullable: true
description: Impressions
default: null
example: 233
Retweets:
type: integer
nullable: true
description: Retweets
default: null
example: 98
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
Reach:
type: integer
nullable: true
description: Reach
default: null
example: 233
Views:
type: integer
nullable: true
description: Views
default: null
example: 253
Clicks:
type: integer
nullable: true
description: Clicks
default: null
example: 235
NetworkEngagements:
type: number
nullable: true
description: Network Engagements
default: null
example: 235
Replies:
type: integer
nullable: true
description: Replies
default: null
example: 116
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: instagram
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: greatdad
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
required:
- results
commonResponse:
type: object
properties:
count:
type: integer
description: Count of all reports
example: 300
dataGenerationTime:
type: string
description: Date when report generated
example: '2023-01-20T13:43:47+00:00'
cached:
type: boolean
description: Is view cached or not
time:
type: number
description: Time taken to generate report
format: float32
example: 0.571
required:
- count
- dataGenerationTime
- cached
- time
pinterestCampaignPostsSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://www.pinterest.com/pin/216946907044571177/'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: image
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
default: null
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Approved
Saves:
type: integer
nullable: true
description: Saves
default: null
example: 15
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
Impressions:
type: integer
nullable: true
description: Impressions
default: null
example: 233
Reach:
type: integer
nullable: true
description: Reach
default: null
example: 233
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: instagram
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: greatdad
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
required:
- results
pinterestWeeklyCampaignUpdatesSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
WeekNum:
type: string
nullable: true
description: Date start of the week when calculated metrics delta
format: date
default: null
example: '2019-04-04'
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://www.pinterest.com/pin/942519028235991787/'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: image
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
default: null
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Approved
Saves:
type: integer
nullable: true
description: Saves
default: null
example: 15
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
Impressions:
type: integer
nullable: true
description: Impressions
default: null
example: 233
Reach:
type: integer
nullable: true
description: Reach
default: null
example: 233
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: pinterest
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: greatdad
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
required:
- results
twitchCampaignPostsSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique Campaign Id
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://www.twitch.tv/videos/1752519236'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: video
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Approved
Views:
type: integer
nullable: true
description: Views
default: null
example: 253
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: instagram
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: greatdad
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
required:
- results
twitchWeeklyCampaignUpdatesSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique Campaign Id
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
WeekNum:
type: string
nullable: true
description: Date start of the week when calculated metrics delta
format: date
example: '2019-04-04'
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://www.twitch.tv/videos/1521164368'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: video
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Approved
Views:
type: integer
nullable: true
description: Views
default: null
example: 253
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: twitch
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: 1_alex_test_12
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78
required:
- results
campaignsByNetworkSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
CampaignStatus:
type: string
nullable: true
description: Campaign Status
maxLength: 50
default: null
example: Active
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
Reach:
type: integer
nullable: true
description: Campaign Summary reach.
default: null
example: 233
Engagement:
type: integer
nullable: true
description: Campaign Summary engagement.
default: null
example: 2323
Impressions:
type: integer
nullable: true
description: Campaign Summary Impressions.
default: null
example: 233
Creators:
type: integer
nullable: true
description: Campaign Total creators
default: null
example: 22
StartDate:
type: string
nullable: true
description: Campaign Start Date
format: date
example: '2020-11-30'
EndDate:
type: string
nullable: true
description: Campaign end Date
format: date
example: '2020-12-30'
LastUpdated:
type: string
nullable: true
description: Campaign Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
Currency:
type: string
nullable: true
description: Campaign Currency
maxLength: 20
default: null
example: USD
DateLastActivityUpdated:
type: string
nullable: true
description: Campaign Date Last Activity Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
TotalBudget:
type: number
nullable: true
description: Total budget for campaign
default: null
example: 100
SalesPerson:
type: string
nullable: true
description: Sales person
maxLength: 50
default: null
example: admin
Manager:
type: string
nullable: true
description: Campaign Manager
maxLength: 50
default: null
example: Manager Name
AccountManagerName:
type: string
nullable: true
description: Campaign Account Manager Name
maxLength: 50
default: null
example: Account Manager Name
CampaignUpdateFrequency:
type: integer
nullable: true
description: Campaign Update Frequency
default: null
example: 24
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
required:
- results
campaignWeeklyUpdatesSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
WeekNum:
type: string
nullable: true
description: Date start of the week when calculated metrics delta
format: date
example: '2019-04-04'
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
SocialNetwork:
type: string
nullable: true
enum:
- YouTube
- Twitter
- Facebook
- Instagram
- Google
- Vine
- Weibo
- Line
- Tiktok
- Twitch
- Tumblr
- Pinterest
- Snapchat
- Linkedin
- Reddit
- Web
- null
description: Social Network
maxLength: 50
example: YouTube
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
Post:
type: string
nullable: true
description: Post
default: null
example: Post text
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: image
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://www.instagram.com/p/CjVgLpCDrtf'
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
example: '2023-02-07'
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Rejected
Engagement:
type: integer
nullable: true
description: Engagement.
default: null
example: 2323
EngagementRate:
type: number
nullable: true
description: Engagement Rate
format: percent
default: null
example: 15.7234
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
Reach:
type: integer
nullable: true
description: Reach
default: null
example: 233
Views:
type: integer
nullable: true
description: Views
default: null
example: 253
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
Likes:
type: integer
nullable: true
description: Likes
default: null
example: 17
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: instagram
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: greatdad
required:
- CampaignId
- id
required:
- results
instagramWeeklyCampaignUpdatesSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
WeekNum:
type: string
nullable: true
description: Date start of the week when calculated metrics delta
format: date
example: '2019-04-04'
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://www.youtube.com/watch?v=eKFqRcvCIMQ'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: image
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Rejected
Likes:
type: integer
nullable: true
description: Likes
default: null
example: 17
Impressions:
type: integer
nullable: true
description: Impressions
default: null
example: 233
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
Reach:
type: integer
nullable: true
description: Reach
default: null
example: 233
Saved:
type: integer
nullable: true
description: Total number of unique Instagram accounts that have saved the IG Media object.
default: null
example: 233
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
Views:
type: integer
nullable: true
description: Views
default: null
example: 253
Replies:
type: integer
nullable: true
description: Replies
default: null
example: 116
TapsForward:
type: integer
nullable: true
description: Total number of taps to see this story IG Media object's next photo or video.
default: null
example: 233
TapsBack:
type: integer
nullable: true
description: Total number of taps to see this story IG Media object's previous photo or video.
default: null
example: 233
Exits:
type: integer
nullable: true
description: Total number of times someone exited the story IG Media object.
default: null
example: 233
SwipeAways:
type: integer
nullable: true
description: Total number of swipes to see IG Media object's and then exited.
default: null
example: 233
SwipeUps:
type: integer
nullable: true
description: Total number of swipe up to see links in the IG story
default: null
example: 233
StickerTaps:
type: integer
nullable: true
description: Total number of Sticker Taps
default: null
example: 23
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: instagram
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: greatdad
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
required:
- results
facebookWeeklyCampaignUpdatesSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: 10209382
WeekNum:
type: string
nullable: true
description: Date start of the week when calculated metrics delta
format: date
example: '2019-04-04'
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://www.facebook.com/100250039129690/posts/140212108466816/'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: text
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Rejected
Likes:
type: integer
nullable: true
description: Likes
default: null
example: 17
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
EngagementRate:
type: number
nullable: true
description: Engagement Rate
format: percent
default: null
example: 15.7234
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
Shares:
type: integer
nullable: true
description: Shares
default: null
example: 62
Views:
type: integer
nullable: true
description: Views
default: null
example: 253
Clicks:
type: integer
nullable: true
description: Clicks
default: null
example: 235
Reach:
type: integer
nullable: true
description: Reach
default: null
example: 233
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
Impressions:
type: integer
nullable: true
description: Impressions
default: null
example: 233
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: facebook
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: greatdad
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
required:
- results
twitterCampaignPostsSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: -80378
WeekNum:
type: string
nullable: true
description: Date start of the week when calculated metrics delta
format: date
example: '2019-04-04'
PublisherName:
type: string
description: Publisher Name
maxLength: 255
example: Chris Whitcroft
SocialHandle:
type: string
nullable: true
description: Social Handle
default: null
example: '@1puglife'
CampaignName:
type: string
nullable: true
description: Campaign name
maxLength: 255
default: null
example: Campaign name
BrandName:
type: string
nullable: true
description: Campaign Brand Name
maxLength: 200
default: null
example: Brand name
PostLink:
type: string
nullable: true
description: Post Link
format: URI
maxLength: 1000
default: null
example: 'https://twitter.com/_blackpinkita/status/1631408244479361025'
PostType:
type: string
nullable: true
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
- null
description: Post Type
maxLength: 20
example: video
DateSubmitted:
type: string
nullable: true
description: Date Submitted
format: date-time
default: null
example: '2023-02-07 03:39:44'
PostDate:
type: string
nullable: true
description: Post Date
format: date
example: '2023-02-07'
Post:
type: string
nullable: true
description: Post full text
default: null
example: Post text
PostStatus:
type: string
nullable: true
enum:
- Actual
- Approved
- Missing
- Rejected
- null
description: Post Status
example: Rejected
Likes:
type: integer
nullable: true
description: Likes
default: null
example: 17
Comments:
type: integer
nullable: true
description: Comments
default: null
example: 3
Impressions:
type: integer
nullable: true
description: Impressions
default: null
example: 233
Retweets:
type: integer
nullable: true
description: Retweets
default: null
example: 98
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
default: null
example: 345
Reach:
type: integer
nullable: true
description: Reach
default: null
example: 233
Views:
type: integer
nullable: true
description: Views
default: null
example: 253
Clicks:
type: integer
nullable: true
description: Clicks
default: null
example: 235
NetworkEngagements:
type: number
nullable: true
description: Network Engagements
default: null
example: 235
Replies:
type: integer
nullable: true
description: Replies
default: null
example: 116
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
description: Linking Status
maxLength: 6
example: Linked
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers At Time Of Post
default: null
example: 223676
LastUpdated:
type: string
nullable: true
description: Last Updated
format: date-time
default: null
example: '2021-11-08 07:58:33'
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
maxLength: 1024
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
maxLength: 512
default: null
example: 'https://social-pictures-storage.s3.amazonaws.com/fe4da4409bd9de12f17ccfe3da07ce67_1605793259.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
maxLength: 50
example: twitter
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
default: null
example: _blackpinkita
Followers:
type: integer
nullable: true
description: Followers
default: null
example: 78247
required:
- results
campaignPostsSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
format: int32
example: 1453672
IsEarnedPost:
type: string
description: |
* 'Yes' this is bonus content else it's required content
example: 'Yes'
LogoURL:
type: string
description: Publisher Logo URL
example: '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'
PublisherName:
type: string
example: sportlivelemur
CampaignId:
type: integer
format: int32
example: 40944
CampaignLogoURL:
type: string
nullable: true
default: null
FlagshipPropertyTitle:
type: string
description: Title of main social account in publisher
example: sportlivelemur
FlagshipSocialNetwork:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
description: Main social network for publisher
example: instagram
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example:
CampaignName:
type: string
example: Campaign
SocialNetwork:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
example: instagram
Reach:
type: integer
nullable: true
example: 3434
Likes:
type: integer
nullable: true
example: 2
Comments:
type: integer
format: int32
example: 1
Retweets:
type: integer
nullable: true
example: 43
Views:
type: integer
nullable: true
description: The number of times that a video was viewed.
example: 3343
EstimatedImpressionsFlag:
type: integer
enum:
- 0
- 1
description: |
* 1 if actual data not available
* 0 Actual data available
format: int32
example: 1
EstimatedReachFlag:
type: integer
enum:
- 0
- 1
description: |
* 1: If private data is not available for this creator
* 0: If private data available
format: int32
example: 1
required:
- PublisherId
required:
- results
campaignSummarySchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique campaign id
format: int32
example: 877416
CampaignName:
type: string
example: TestCampaign
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
default: null
example: 'https://campaignLogo.jpg'
NumberOfInfluencers:
type: integer
description: Count of influencers in campaign
format: int32
example: 5
YTPosts:
type: integer
description: Count of youtube posts in campaign
format: nullable
example: 5
SocialPosts:
type: integer
description: Count of posts in campaign
format: int32
example: 6
TotalPosts:
type: integer
format: int32
example: 6
Likes:
type: integer
description: Count of all likes in campaign
format: int32
example: 299
Comments:
type: integer
description: Count of all comments in campaign
format: int32
example: 6
Views:
type: integer
description: Count of all views in campaign
example: 299
MinutesWatched:
type: integer
example: 23
Retweets:
type: integer
nullable: true
example: 4
TotalShares:
type: integer
nullable: true
example: 4
required:
- CampaignId
- CampaignName
required:
- results
campaignTopInfluencersSchema:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
description: Unique publisher id
format: int32
example: 3293835
PublisherName:
type: string
description: Name of the publisher
example: Admin
NumOfCampaigns:
type: integer
description: Count of campaign where publisher presented
format: int32
example: 201
CampaignsWithPosts:
type: integer
description: Count of campaigns with posts
format: int32
example: 56
NumOfPosts:
type: integer
description: All count of posts for this publisher
format: int32
example: 1220
LogoURL:
type: string
example: 'https://social-pictures-storage.s3.amazonaws.com/2df752c70d486f89a38cd86ca9b33981_1619438598.jpg'
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: Cristiano
FlagshipPropertyTitle:
type: string
nullable: true
description: Title of main social account in publisher
example: Cristiano
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for this publisher
example: twitter
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example:
TotalSubscribers:
type: integer
description: All subscribers for all social networks for this publisher
format: int32
example: 812561989
required:
- results
campaignPublishers:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 311680
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
example: 'https://logoUrl.jpg'
CampaignId:
type: integer
example: 218073
CampaignLogoURL:
type: string
format: URI
example: 'https://socialedge-campaigns.s3.amazonaws.com/218073.png'
PublisherName:
type: string
example: Movies on Facebook
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: therock
FlagshipPropertyTitle:
type: string
nullable: true
description: Title of main social account in publisher
example: therock
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- YouTube
- Twitter
- Facebook
- Instagram
- Google
- Vine
- Weibo
- Line
- Tiktok
- Twitch
- Tumblr
- Pinterest
- Snapchat
- Linkedin
- Reddit
- Web
- null
description: Main social network for publisher
example: Instagram
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
default: null
CampaignName:
type: string
example: Test Campaign
CampaignStatus:
type: string
example: Active
required:
- PublisherId
required:
- results
campaignVideos:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique campaign id
example: 45303
CampaignLogoURL:
type: string
nullable: true
format: URI
example: 'https://campaignLogoUrl.jpg'
CampaignName:
type: string
example: Campaign
DateSubmitted:
type: string
description: Date when video submitted
example: '2020-03-08 16:37:46.0000000'
FlagshipPropertyTitle:
type: string
description: Title of main social account in publisher
example: therock
FlagshipSocialNetwork:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
description: Main social network for publisher
example: instagram
Post:
type: string
description: Text of post
example: Text of post
PublisherId:
type: integer
format: int32
example: 1920179
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example:
Views:
type: integer
example: 235
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
example: 'https://logo.jpg'
PublisherName:
type: string
example: John Doe
required:
- results
instagramCampaignPosts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
example: 876358
id:
type: integer
description: Unique row id
example: 2344
PublisherName:
type: string
example: Planeta
SocialHandle:
type: string
example: therock
CampaignName:
type: string
example: Super Campaign
BrandName:
type: string
example: Brand
PostLink:
type: string
format: URI
example: 'https://linkToPost'
PostType:
type: string
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
example: image
DateSubmitted:
type: string
description: Date when post submitted
example: '2023-01-03 00:00:41'
PostDate:
type: string
example: '2023-01-03'
Post:
type: string
description: Body of the post
example: Text of post
PostStatus:
type: string
example: Approved
Likes:
type: integer
nullable: true
description: The number of likes on your post.
example: 233
Impressions:
type: integer
nullable: true
description: Total number of times the IG Media object has been seen.
example: 233
Comments:
type: integer
nullable: true
description: The number of comments on your post.
example: 233
Reach:
type: integer
nullable: true
description: Total number of unique Instagram accounts that have seen the IG Media object.
example: 233
Saved:
type: integer
nullable: true
description: Total number of unique Instagram accounts that have saved the IG Media object.
example: 233
SMV:
type: integer
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
example: 233
Views:
type: integer
nullable: true
description: The number of times that a video was viewed.
example: 233
Replies:
type: integer
nullable: true
description: Total number of replies (IG Comments) on the story IG Media object.
example: 233
TapsForward:
type: integer
nullable: true
description: Total number of taps to see this story IG Media object's next photo or video.
example: 233
TapsBack:
type: integer
nullable: true
description: Total number of taps to see this story IG Media object's previous photo or video.
example: 233
Exits:
type: integer
nullable: true
description: Total number of times someone exited the story IG Media object.
example: 233
SwipeAways:
type: integer
nullable: true
description: Total number of swipes to see IG Media object's and then exited.
example: 233
SwipeUps:
type: integer
nullable: true
description: Total number of swipe up to see links in the IG story
example: 233
StickerTaps:
type: integer
nullable: true
example: 233
FollowersAtTimeOfPost:
type: integer
nullable: true
example: 233
LinkingStatus:
type: string
nullable: true
default: null
example: Linked
PublisherId:
type: integer
description: Unique id of publisher
example: 23455
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://logoUrl.png'
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://thimbLogoUrl.png'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: instagram
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: therock
Followers:
type: integer
example: 1223
required:
- CampaignId
- id
- PublisherName
- SocialHandle
required:
- results
youtubeCampaignPosts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: object
properties:
CampaignId:
type: integer
example: 856026
id:
type: integer
description: Unique row id
example: 1244
PublisherName:
type: string
example: John Doe
CampaignName:
type: string
example: My Campaign
BrandName:
type: string
example: Cola
PostLink:
type: string
example: 'https://linkToPost.com/video'
DateSubmitted:
type: string
example: '2023-01-03 06:48:43'
PostDate:
type: string
example: '2023-01-03'
Post:
type: string
nullable: true
example: Description of post
PostTitle:
type: string
example: Post title
PostStatus:
type: string
example: Approved
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
format: float
example: 1705783.696
Views:
type: integer
nullable: true
description: The number of times that a video was viewed.
format: int32
example: 2323
FollowersAtTimeOfPost:
type: integer
nullable: true
format: int32
example: 232322
ViewsOrganic:
type: string
nullable: true
description: Number of times a viewer watches a video without any prompts such as ads.
default: null
MinutesWatchedOrganic:
type: integer
nullable: true
description: 'Duration of the video watched in minutes when a viewer clicks on elements of your video ad such as calls-to-action (CTA), cards, banners, thumbnails, or logos.'
default: null
example: 2323
ViewsPaid:
type: integer
nullable: true
description: 'The number of times viewers view a larger portion or the entirety of your ad, beyond just the impression.'
default: null
example: 23233
MinutesWatchedPaid:
type: integer
nullable: true
format: int32
default: null
example: 2323
LinkingStatus:
type: string
nullable: true
enum:
- Linked
- Broken
- null
example: Linked
LastUpdated:
type: string
example: '2023-01-09 07:59:13'
PublisherId:
type: integer
format: int32
example: 23233
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
example: 'https://logoUrl.png'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
example: 'https://small-logo-url.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: youtube
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: TheRock
required:
- results
youtubeWeeklyCampaignUpdates:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
description: Unique CampaignId
format: int32
example: 697096
id:
type: integer
description: Unique id of row
format: int32
example: 232323
WeekNum:
type: string
description: Date start of the week when calculated metrics delta
example: '2022-10-05 00:00:00'
PublisherName:
type: string
example: therock
SocialHandle:
type: string
description: Username from instagram
example: qohenl
CampaignName:
type: string
example: Test Campaign
BrandName:
type: string
example: Brand Name
PostLink:
type: string
description: Link to post which changed
format: URI
example: 'https://www.instagram.com/p/CjVgLpCDrtf'
PostType:
type: string
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
example: image
DateSubmitted:
type: string
description: Date when post submitted
example: '2022-10-05 07:49:32'
PostDate:
type: string
example: '2022-10-05'
Post:
type: string
nullable: true
example: '#shiny_new'
PostStatus:
type: string
example: Approved
SMV:
type: number
nullable: true
description: Social Media Value. It is used to measure the value of the influencer campaign against the cost of driving the same results via paid social media advertising
format: float
example: 2.34
Views:
type: integer
description: The number of times that a video was viewed.
example: 12
Engagement:
type: integer
description: 'Sum of likes_count, comment_count, and saved counts on the IG Media.'
example: 2323
FollowersAtTimeOfPost:
type: integer
nullable: true
format: int32
example: 232322
ViewsOrganic:
type: integer
description: Number of times a viewer watches a video without any prompts such as ads.
example: 123
MinutesWatchedOrganic:
type: integer
description: 'Duration of the video watched in minutes when a viewer clicks on elements of your video ad such as calls-to-action (CTA), cards, banners, thumbnails, or logos.'
example: 1222
ViewsPaid:
type: integer
description: 'The number of times viewers view a larger portion or the entirety of your ad, beyond just the impression.'
example: 321
MinutesWatchedPaid:
type: integer
nullable: true
format: int32
default: null
example: 2323
LinkingStatus:
type: string
nullable: true
enum:
- Linked
- Broken
- null
example: Linked
LastUpdated:
type: string
example: '2023-01-09 07:59:13'
PublisherId:
type: integer
format: int32
example: 23233
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
example: 'https://logoUrl.png'
ThumbLogoURL:
type: string
nullable: true
description: Publisher Logo URL with reduced size
format: URI
example: 'https://small-logo-url.jpg'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: youtube
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: TheRock
Followers:
type: integer
example: 3
required:
- results
followerFraudAuditSummary:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 23332
PublisherName:
type: string
example: John Doe
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://logoUrl.jpg'
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
example: 'https://smallLogourl.jpg'
TotalSubscribers:
type: integer
description: All subscribers from all social accounts for this publisher
example: 3344
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example:
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: therock
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: instagram
FlagshipPropertyTitle:
type: string
nullable: true
description: Title of main social account in publisher
example: therock
CIQCertifiedFlag:
type: integer
enum:
- 0
- 1
description: |
Flag represents in publisher verified or not
* 1: Publisher verified
* 0: Publisher not verified
example: 0
CIQCertifiedFlagDate:
type: string
nullable: true
description: Date when CIQCertifiedFlag was set
default: null
TotalFraudFlags:
type: integer
description: Total flags in publisher
example: 3
Linked:
type: integer
enum:
- 0
- 1
description: Has publisher linked accounts or no * 1 if any social account verified with social network * 0 does not have verified social accounts
example: 0
Unlinked:
type: integer
enum:
- 0
- 1
description: |
* 0 represents account linked
* 1 represents account unlinked
example: 1
LinkBroken:
type: integer
enum:
- 0
- 1
description: Some of account is no longer authenticated.
example: 0
Verified:
type: integer
enum:
- 0
- 1
description: Has verified social account
example: 0
NetworkId:
type: integer
description: Id of partner
example: 21
CIQ ID:
type: integer
description: Alias of publisherId
example: 2747744
'Creator #':
type: integer
description: 'Internal unique id of publisher. The same as NetworkPublisherId '
example: 232323
AudienceFlags:
type: integer
default: 0
example: 3
WorstAudienceFlag:
type: string
description: Extended description of AudienceFlags. Used on UI
default: Not Flags
example: Not Flags
GrowthFlags:
type: integer
enum:
- 0
- 1
description: We flag creators who have had a month over month growth rate in excess of 25%
default: 0
example: 0
WorstGrowthFlag:
type: string
description: Extended description of GrowthFlags value. Used on UI
example: Not enough growth data to determine
EngagementFlags:
type: integer
description: 'Creator’s with an engagement rate flag may be low-performing creators, or the low ER may be a symptom of buying followers but not buying enough engagements.'
example: 1
WorstEngagementFlag:
type: string
description: Extended description of EngagementFlags.Used on UI
example: Instagram - 0.36% is in bad range below the 0.79% threshold
'# of Categories':
type: integer
description: Field user in UI
example: 1
Notes:
type: string
example: Note
FB:
type: integer
description: Count of Facebook accounts checked with audience integrity
example: 1
YT:
type: integer
description: Count of Youtube accounts checked with audience integrity
example: 1
TW:
type: integer
description: Count of Twitter accounts checked with audience integrity
example: 2
IG:
type: integer
description: Count of Instagram account checked with audience integrity
example: 2
STATUS:
type: string
description: Current status of publisher
example: OPEN
StatusCategory:
type: string
description: Additional information about recruiting status.
example: In process
required:
- PublisherId
required:
- results
creatorsPaymentStatusDetails:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 95325
PublisherName:
type: string
example: John Doe
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://smallLogourl.jpg'
LastLoginDate:
type: string
nullable: true
description: Datetime when publisher logged
example: '2021-07-27 18:41:48'
DateOpenedPaymentCollectionPage:
type: string
nullable: true
example: '2021-07-27 18:41:48'
Payable:
type: integer
nullable: true
enum:
- 0
- 1
- null
example: 1
NotPayableReason:
type: string
nullable: true
example: Not checked yet
PayableDate:
type: string
nullable: true
example: '2021-07-27 18:41:48'
PaymentStatusRefreshedDate:
type: string
nullable: true
example: '2021-07-27 18:41:48'
required:
- PublisherId
required:
- results
growthRate:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 23332
PublisherName:
type: string
example: John Doe
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://logoUrl.jpg'
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://thumbLogoUrl.jpg'
CIQID:
type: integer
description: Alias for PublisherId
format: int32
example: 23332
PartnerId:
type: integer
format: int32
minimum: 1
example: 21
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
description: Social account which represents growth rate
example: instagram
NetworkUser:
type: string
description: Social handle
example: therock
SocialId:
type: integer
description: Unique social Id
example: 1682572
ActualFollowersNumber:
type: integer
description: Followers count for publisher
format: int32
example: 220000
StatDateYear:
type: integer
format: int32
example: 2022
StatDateMonth:
type: integer
format: int32
minimum: 1
maximum: 12
example: 12
Followers:
type: integer
format: int32
example: 2323
PrevMonthFollowers:
type: integer
format: int32
example: 100
GrowthRatePercentage:
type: number
format: float
example: 25.06
GrowthRate:
type: number
format: float
example: 0.0024
RowNum:
type: integer
description: For internal usage
example: 0
IgnoreFlag:
type: integer
enum:
- 0
- 1
description: |
* If 1 then do not report publisher as fraud
* If 0 then calculate fraud flags
default: 0
example: 0
IgnoredBy:
type: string
nullable: true
description: User which setup IgnoreFlag
default: null
example: Admin
IgnoredAt:
type: string
nullable: true
description: When IgnoreFlag flag is setup
default: null
example: '2019-01-23 18:16:33.000'
IgnoreNote:
type: string
nullable: true
default: null
example: Note
required:
- PublisherId
- PublisherName
required:
- results
engagementRate:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 23332
PublisherName:
type: string
example: John Doe
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://logoUrl.jpg'
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://thumbLogoUrl.jpg'
CIQID:
type: integer
description: Alias for PublisherId
format: int32
example: 23332
PartnerId:
type: integer
description: Unique id of network
format: int32
minimum: 1
example: 21
ChannelId:
type: integer
description: Unique social handle id in social network
format: int32
example: 2323333
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
description: Social account which represents growth rate
example: instagram
NetworkUser:
type: string
description: Social handle of network
example: therock
Followers:
type: integer
format: int32
example: 2323
RowNum:
type: integer
description: For internal usage
example: 2
IgnoreFlag:
type: integer
enum:
- 0
- 1
example: 0
IgnoredBy:
type: string
nullable: true
default: null
example: Admin
IgnoredAt:
type: string
nullable: true
default: null
IgnoreNote:
type: string
nullable: true
default: null
example: Note
required:
- PublisherId
- PublisherName
required:
- results
brokenLinks:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 6331900
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
example: 'https://logoPublisherUrl.png'
AccountHandle:
type: string
description: Name account which link broken
example: therock
PublisherName:
type: string
example: Therock
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
example: instagram
DateInviteLinkSent:
type: string
nullable: true
example: '2022-01-18'
DateBroken:
type: string
example: '2022-07-08'
DateLinked:
type: string
example: '2019-12-03'
LinkingStatus:
type: string
enum:
- Broken
CreatorEmail:
type: string
format: email
example: test@mail.com
textLink:
type: string
description: Link to 'Link accounts page'
format: URI
example: 'https://linkToAccountPage.com/linksAccountPage'
ManagementCompany:
type: string
nullable: true
default: null
example: Manager
AgentName:
type: string
nullable: true
default: null
example: John Doe
AgentEmail:
type: string
format: email
example: test@mail.com
ExpirationDate:
type: string
description: Date when link expired
example: '2022-06-20'
required:
- results
linkedAccounts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 6331900
CIQId:
type: integer
example: 6331900
PublisherName:
type: string
example: Therock
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://social-pictures-storage.s3.us-west-1.amazonaws.com/Resized/Logo/Low/21435443422_Instagram_Logo.jpg'
NetworkId:
type: integer
example: 21
PID:
type: integer
example: 6331900
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
example: youtube
Handle:
type: string
description: Handle of account
example: CVWDbXqQ8cupuVpotWNt2eg
Followers:
type: integer
example: 72357247
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
example: Broken
DateLinked:
type: string
nullable: true
example: '2020-01-06'
DateBroken:
type: string
nullable: true
example: '2021-01-04'
DateInviteLinkSent:
type: string
nullable: true
example: '2021-01-04'
ExpirationDate:
type: string
nullable: true
example: '2021-01-04'
required:
- PublisherId
- CIQId
required:
- results
allLinkedAccounts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 6331900
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://logoPublisherUrl.png'
AccountHandle:
type: string
description: Name account which link broken
example: therock
PublisherName:
type: string
example: Therock
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
example: instagram
DateInviteLinkSent:
type: string
nullable: true
example: '2022-01-18'
LinkingStatus:
type: string
enum:
- Broken
- Linked
DateLinked:
type: string
example: '2019-12-03'
CreatorName:
type: string
description: Creator's email
format: email
example: test@mail.com
textLink:
type: string
description: Link to 'Link accounts page'
format: URI
example: 'https://linkToAccountPage.com/linksAccountPage'
ManagementCompany:
type: string
nullable: true
default: null
example: Manager
AgentName:
type: string
nullable: true
default: null
example: John Doe
AgentEmail:
type: string
nullable: true
format: email
example: test@mail.com
DateBroken:
type: string
nullable: true
example: '2022-07-08'
required:
- results
nonLinkedAccounts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 6331900
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://social-pictures-storage.s3.us-west-1.amazonaws.com/Resized/Logo/Low/21435443422_Instagram_Logo.jpg'
AccountHandle:
type: string
example: '74724725725828'
PublisherName:
type: string
example: Therock
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
example: pinterest
DateInviteLinkSent:
type: string
nullable: true
example: '2021-01-04'
CreatorEmail:
type: string
format: email
example: test@mail.com
textLink:
type: string
description: Link to 'Link accounts page'
format: URI
example: 'https://linkToAccountPage.com/linksAccountPage'
ManagementCompany:
type: string
nullable: true
default: null
example: Manager
AgentName:
type: string
nullable: true
default: null
example: John Doe
AgentEmail:
type: string
nullable: true
format: email
example: test@mail.com
required:
- PublisherId
required:
- results
creatorPayments:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://logoPublisherUrl.png'
CampaignName:
type: string
example: Campaign name
CampaignId:
type: integer
example: 6331900
PublisherName:
type: string
example: Campaign name
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: some_name
PublisherId:
type: integer
example: 725371
PaymentTerm:
type: integer
nullable: true
example: 30
RequirementsCompletedAt:
type: string
nullable: true
example: '2023-02-16 16:32:33.0000000 +00:00'
PaymentDueDate:
type: string
nullable: true
example: '2023-03-17 16:32:33.000'
FinalPayout:
type: number
nullable: true
example: 723.5
StatusOfPayment:
type: string
nullable: true
enum:
- Ready to Pay
- Sent
- Paid
- Cleared
- Rejected
- null
example: Ready to Pay
required:
- CampaignId
- PublisherId
required:
- results
campaignsPosts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
example: 6331900
PostId:
type: integer
example: 723146
PublisherName:
type: string
example: greatdad
SocialHandle:
type: string
example: greatdad
SocialNetwork:
type: string
enum:
- YouTube
- Twitter
- Facebook
- Instagram
- Google
- Vine
- Weibo
- Line
- Tiktok
- Twitch
- Tumblr
- Pinterest
- Snapchat
- Linkedin
- Reddit
- Web
example: Instagram
CampaignName:
type: string
example: Campaign name
BrandName:
type: string
example: Brand name
Post:
type: string
example: Post text
PostLink:
type: string
format: URI
example: 'https://post.link/url'
DateSubmitted:
type: string
example: '2023-02-07 03:39:44'
PostDate:
type: string
example: '2023-02-07'
PostStatus:
type: string
enum:
- Actual
- Approved
- Missing
- Rejected
example: Actual
Engagement:
type: integer
nullable: true
example: 6
EngagementRate:
type: number
nullable: true
example: 15.7234
Followers:
type: integer
nullable: true
example: 78247
FollowersAtTimeOfPost:
type: integer
nullable: true
example: 14575
Reach:
type: integer
nullable: true
example: 6
Views:
type: integer
nullable: true
example: 253
LinkingStatus:
type: string
nullable: true
enum:
- Broken
- Linked
- null
example: Linked
Likes:
type: integer
nullable: true
example: 17
Comments:
type: integer
nullable: true
example: 3
PublisherId:
type: integer
example: 72537
CreatorId:
type: integer
example: 72537
LastUpdated:
type: string
example: '2023-02-15 08:12:54'
SMV:
type: number
example: 345.67229
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://logoPublisherUrl.png'
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://thumbLogoPublisherUrl.png'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: facebook
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: greatdad
AvgEngagementRate:
type: number
example: 0.1237
Impressions:
type: integer
nullable: true
example: 11
TotalShares:
type: integer
nullable: true
example: 62
Replies:
type: integer
nullable: true
example: 116
Retweets:
type: integer
nullable: true
example: 98
Clicks:
type: integer
nullable: true
example: 235
Saves:
type: integer
nullable: true
example: 15
TapsBack:
type: integer
nullable: true
example: 27
SwipeUps:
type: integer
nullable: true
example: 8
StickerTaps:
type: integer
nullable: true
example: 31
pnk_hash:
type: string
nullable: true
example: 057a0175c9434a2d1eef6fd1c0a6983b
required:
- CampaignId
- PostId
- PublisherId
required:
- results
campaignMessaging:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignName:
type: string
example: Campaign name
CampaignId:
type: integer
example: 6331900
Tier:
type: string
nullable: true
example: Some tier
Manager:
type: string
example: Manager Name
CampaignLogoURL:
type: string
nullable: true
format: URI
example: 'https://logoCampaignUrl.png'
PublisherName:
type: string
example: greatdad
PublisherID:
type: integer
example: 72537
FlagshipSocialNetwork:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
description: Main social network for publisher
example: instagram
FlagshipPropertyTitle:
type: string
description: Title of main social account in publisher
example: greatdad
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://logoPublisherUrl.png'
Event:
type: string
nullable: true
example: acceptedToCampaign
Subject:
type: string
example: CONGRATULATIONS! - You Are Accepted to CampaignName
EmailMetrics:
type: string
nullable: true
enum:
- Delivered
- Opened
- Bounced
- Marked as Spam
- Error
- Sent
- null
description: 'Rarely the value might differ from the enumerated list, there are just hardly defined values'
example: Opened
EmailClicks:
type: string
enum:
- 'Yes'
- 'No'
example: 'No'
EmailSentDate:
type: string
example: '2023-02-27'
EmailId:
type: string
example: '-2134893000|13253111'
required:
- CampaignName
- CampaignId
- PublisherName
- EmailSentDate
required:
- results
reachReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 752272
PublisherName:
type: string
example: Creator name
TotalConnections:
type: integer
nullable: true
example: 2378525
TotalSocialConnections:
type: integer
nullable: true
example: 46102506
sYT_Name:
type: string
nullable: true
example: '@shane'
sYT_Followers:
type: integer
nullable: true
example: 72352
YT_Id:
type: integer
nullable: true
example: 8245157
sIG_Name:
type: string
nullable: true
example: haleypham
sIG_Followers:
type: integer
nullable: true
example: 27357
IG_Id:
type: integer
nullable: true
example: 4575
sFB_Name:
type: string
nullable: true
example: vcsabia
sFB_Followers:
type: integer
nullable: true
example: 72524
FB_Id:
type: integer
nullable: true
example: 27821
sTW_Name:
type: string
nullable: true
example: DominoKati
sTW_Followers:
type: integer
nullable: true
example: 942542
TW_Id:
type: integer
nullable: true
example: 82725
sWB_Name:
type: string
nullable: true
example: www.carlosvives.com
sWB_Followers:
type: integer
nullable: true
example: 1923
WB_Id:
type: integer
nullable: true
example: 427299
sPN_Name:
type: string
nullable: true
example: nztinyhouse
sPN_Followers:
type: integer
nullable: true
example: 27624
PN_Id:
type: integer
nullable: true
example: 5669213
required:
- PublisherId
- PublisherName
required:
- results
channelReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
minItems: 1
items:
type: object
properties:
PublisherId:
type: integer
example: 4234940
ChannelId:
type: integer
example: 6327517
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://yt3.ggpht.com/ytc/AL5GRJW72viQH8jaCBXPwVgIOXAdGGxgB6_p1Yw2mOkfCA=s88-c-k-c0x00ffffff-no-rj-mo'
PublisherName:
type: string
example: therock
Email:
type: string
format: email
example: channel@gmail.com
ChannelName:
type: string
example: TheRock
YT_Subscribers:
type: integer
example: 2323232
YT_AverageMonthlyViews:
type: integer
example: 232322
ChannelStatus:
type: string
enum:
- Active
- Open
StatusCategory:
type: string
example: In Network
NetworkPublisherId:
type: string
example: '10003967859'
Channel:
type: string
example: ChannelTitle
ContentOwner:
type: string
example: Movieclips
required:
- PublisherId
required:
- results
creatorContactInfoReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
minItems: 1
items:
type: object
properties:
PublisherId:
type: integer
example: 4234940
NetworkPublisherId:
type: integer
example: 4234940
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://url.to/logoUrl.png'
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://url.to/thumbLogoUrl.png'
PublisherName:
type: string
example: therock
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: therocker
FlagshipPropertyTitle:
type: string
nullable: true
description: Title of main social account in publisher
example: therocker
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: youtube
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example: 'youtubeUC4PooiX37Pld1T8J5Sj7tpC@therocker120Good Mythical Morning18100000101002023-03-02T20:08:00
'
Full Name:
type: string
example: The Rockie Rocker
Email:
type: string
nullable: true
format: email
example: channel@gmail.com
PhoneNumber1:
type: string
nullable: true
example: '04444444444'
StreetAddress1:
type: string
nullable: true
example: afdhsdfhfdhfda
StreetAddress2:
type: string
nullable: true
example: jfgsd setah
City:
type: string
nullable: true
example: City Name
State:
type: string
nullable: true
example: AL
ZipCode:
type: string
nullable: true
example: '11111'
Country:
type: string
nullable: true
example: Albania
Birthday:
type: string
nullable: true
example: '1984-02-27'
IsEmailExists:
type: string
nullable: true
example: 'Yes'
required:
- PublisherId
required:
- results
importTemplateReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
minItems: 1
items:
type: object
properties:
PublisherId:
type: integer
example: 4234940
PublisherName:
type: string
example: therock
Status:
type: string
example: Open
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://url.to/logoUrl.png'
IG_Handle:
type: string
nullable: true
example: dfghg
TW_Handle:
type: string
nullable: true
example: jstgj
FB_Handle:
type: string
nullable: true
example: asetsah
PN_Handle:
type: string
nullable: true
example: tebf
Tumblr_Handle:
type: string
nullable: true
example: ssg
WEB_Handle:
type: string
nullable: true
example: juwaryas
SP_Handle:
type: string
nullable: true
example: asdtyterusrz
Channel:
type: string
nullable: true
example: waeuias
DateOfBirth:
type: string
nullable: true
example: '1995-05-19'
Gender:
type: string
nullable: true
example: Female
LANGUAGE:
type: string
nullable: true
example: 'Czech, Korean, English'
Description:
type: string
nullable: true
example: Some description
SubNetworkName:
type: string
nullable: true
example: test
OutsideManagerName:
type: string
nullable: true
example: Melissa
CustomValue1:
type: string
nullable: true
example: ''
CustomValue2:
type: string
nullable: true
example: ''
CustomValue3:
type: string
nullable: true
example: ''
CustomValue4:
type: string
nullable: true
example: ''
CustomValue5:
type: string
nullable: true
example: ''
AccountManagerName:
type: string
nullable: true
example: Mike
Category:
type: string
nullable: true
example: 'Politics, News & Journalism'
Tags:
type: string
nullable: true
example: '"World","Action","and","Reaction","News"'
Email:
type: string
nullable: true
example: test@example.com
StatusCategory:
type: string
nullable: true
example: In process
PhoneNumber1:
type: string
nullable: true
example: '099999999999'
StreetAddress:
type: string
nullable: true
example: jfgsd setah
City:
type: string
nullable: true
example: City Name
State:
type: string
nullable: true
example: AL
ZipCode:
type: string
nullable: true
example: '11111'
Country:
type: string
nullable: true
example: Albania
ManagementCompany:
type: string
nullable: true
example: Some Company
required:
- PublisherId
required:
- results
dailyCampaignPosts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
minItems: 1
items:
type: object
properties:
brand:
type: string
description: Name of the Brand which the Campaign is addressed to
example: Brand name
campaign:
type: string
description: Campaign's name
example: Some Campaign
campaignid:
type: integer
description: Campaign Id
example: 834527
campaigncost:
type: number
nullable: true
description: Cost of the whole Campaign
example: 30000.5
influencer:
type: string
description: Creator's name
example: John Doe
creatorid:
type: integer
description: Creator Id
example: 34624
postid:
type: string
description: Post Id
example: gdHWgste9f3
permalink:
type: string
description: Permalink to the post
format: URI
example: 'https://url.to/post'
platform:
type: string
enum:
- YouTube
- Twitter
- Facebook
- Instagram
- Google
- Vine
- Weibo
- Line
- Tiktok
- Twitch
- Tumblr
- Pinterest
- Snapchat
- Linkedin
- Reddit
- Web
description: Name of Social Network
example: Twitch
postformat:
type: string
enum:
- permalink
- story
- image
- reel
- Photo
- video
- tweet
- TiktokPost
- stream
- other
- article
- status
- blog
- short
- link
- carousel
- clip
- post
- text
- Album
description: Type of the post
example: video
postdate:
type: string
description: Date of the post
example: '2014-08-31 02:31:29'
caption:
type: string
nullable: true
description: Post caption
example: some text
datedatapulled:
type: string
description: Date of the post last pulled
example: '2016-02-19 00:00:00'
impressions:
type: integer
nullable: true
description: Impressions
example: 234
reach:
type: integer
nullable: true
description: Reach
example: 234
totalengagements:
type: integer
nullable: true
description: Total Engagements
example: 234
engagementrate:
type: number
nullable: true
description: Engagement rate
example: 1.49
followers:
type: integer
nullable: true
description: Followers of the Creator
example: 234
contentlikes:
type: integer
nullable: true
description: Likes count
example: 234
comments:
type: integer
nullable: true
description: Comments count
example: 234
shares:
type: integer
nullable: true
description: Shares count
example: 234
saved:
type: integer
nullable: true
description: Shares count
example: 234
videoviews:
type: integer
nullable: true
description: Video views count
example: 234
clicks:
type: integer
nullable: true
description: Clicks count
example: 234
socialmediavalue:
type: number
nullable: true
description: Social media value
example: 234.12
logourl:
type: string
nullable: true
description: Creator Logo URL
format: URI
example: 'https://social-pictures-storage.s3-us-west-1.amazonaws.com/thumbs/instagram-111.jpg'
daynum:
type: string
description: Date of the post last pulled (duplicate)
example: '2016-02-19 00:00:00'
id:
type: integer
description: Post Id in CIQ
example: 5724825
pnk_hash:
type: string
nullable: true
example: 057a0175c9434a2d1eef6fd1c0a6983b
required:
- campaignid
- creatorid
- postid
required:
- results
creatorPromote:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
minItems: 1
items:
type: object
properties:
CIQId:
type: integer
description: Creator Id in CIQ
example: 52717781
PublisherName:
type: string
example: John Doe
SocialNetwork:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
example: instagram
NetworkUser:
type: string
example: john.doe.ig
DatePermissionsGranted:
type: string
description: Date of Permissions has been granted for publisher
example: '2023-03-03'
AdPermissionExpirationDate:
type: string
example: '2023-04-16'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: facebook
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: john.doe.fb
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example: 'instagram103892434426157john.doe.ig100john.doe.ig14John Doe2022-07-18T13:28:34000102022-10-20T08:44:24.1472023-03-01T16:35:33
'
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://social-pictures-storage.s3.amazonaws.com/medium_f60bb277b588e9dc652f2abe8197864457257.jpeg'
PublisherId:
type: integer
example: 72537585
required:
- PublisherId
required:
- results
creatorsReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
description: |
Depending on the partner, the report may contain different set of properties.
minItems: 1
items:
type: object
properties:
average_facebook_post_engagement_rate:
type: number
nullable: true
example: 0.2345
average_facebook_post_engagements_per_post:
type: number
nullable: true
example: 567.89
average_facebook_post_impressions_per_post:
type: number
nullable: true
example: 2345.67
average_facebook_post_reach_per_post:
type: number
nullable: true
example: 890.12
average_instagram_post_engagement_rate:
type: number
nullable: true
example: 0.1234
average_instagram_post_engagements_per_post:
type: number
nullable: true
example: 456.78
average_instagram_post_impressions_per_post:
type: number
nullable: true
example: 1234.56
average_instagram_post_reach_per_post:
type: number
nullable: true
example: 789.01
average_tiktok_post_engagement_rate:
type: number
nullable: true
example: 0.4567
average_tiktok_post_engagements_per_post:
type: number
nullable: true
example: 789.01
average_tiktok_post_impressions_per_post:
type: number
nullable: true
example: 4567.89
average_tiktok_post_reach_per_post:
type: number
nullable: true
example: 123.45
average_twitch_post_engagement_rate:
type: number
nullable: true
example: 0.5678
average_twitch_post_engagements_per_post:
type: number
nullable: true
example: 890.12
average_twitch_post_impressions_per_post:
type: number
nullable: true
example: 5678.9
average_twitch_post_reach_per_post:
type: number
nullable: true
example: 234.56
average_twitter_post_engagement_rate:
type: number
nullable: true
example: 0.6789
average_twitter_post_engagements_per_post:
type: number
nullable: true
example: 901.23
average_twitter_post_impressions_per_post:
type: number
nullable: true
example: 6789.01
average_twitter_post_reach_per_post:
type: number
nullable: true
example: 345.67
average_youtube_post_engagement_rate:
type: number
nullable: true
example: 0.3456
average_youtube_post_engagements_per_post:
type: number
nullable: true
example: 678.9
average_youtube_post_impressions_per_post:
type: number
nullable: true
example: 3456.78
average_youtube_post_reach_per_post:
type: number
nullable: true
example: 901.23
count_of_facebook_posts_within_date_range:
type: integer
nullable: true
example: 3
count_of_instagram_posts_within_date_range:
type: integer
example: 5
count_of_tiktok_posts_within_date_range:
type: integer
nullable: true
example: 4
count_of_twitch_posts_within_date_range:
type: integer
nullable: true
example: 6
count_of_twitter_posts_within_date_range:
type: integer
nullable: true
example: 7
count_of_youtube_posts_within_date_range:
type: integer
nullable: true
example: 2
creator_city:
type: string
nullable: true
example: Los Angeles
creator_country:
type: string
example: United States
creator_primary_social_platform:
type: string
example: instagram
creator_primary_social_title:
type: string
nullable: true
example: '@johndoe22222'
creator_state:
type: string
nullable: true
example: California
crm_email:
type: string
nullable: true
description: |
This property may be missing for some partners.
format: email
example: john.doe@mail.com
json_of_associated_social_handles:
type: array
items:
type: object
additionalProperties:
type: string
example: azevedoja
example:
- instagram: azevedoja
- twitter: azevedoja
disco_emails:
type: string
nullable: true
description: |
This property may be missing for some partners.
example: 'john.doe@mail.com,jane.doe@mail.com'
primary_audience_interest_category:
type: string
nullable: true
example: Beauty
primary_creator_category:
type: string
nullable: true
example: Fashion
primary_creator_travel_affinity_city:
type: string
nullable: true
example: New York
publisherid:
type: integer
example: 72537585
publishername:
type: string
example: John Doe
secondary_audience_interest_category:
type: string
nullable: true
example: Travel
secondary_creator_category:
type: string
nullable: true
example: Lifestyle
secondary_creator_travel_affinity_city:
type: string
nullable: true
example: Los Angeles
tags:
type: string
nullable: true
example: '"Science & Technology","News"'
total_facebook_fans:
type: integer
nullable: true
example: 2345678
total_instagram_followers:
type: integer
nullable: true
example: 1234567
total_tiktok_followers:
type: integer
nullable: true
example: 4567890
total_twitch_subscribers:
type: integer
nullable: true
example: 5678901
total_twitter_followers:
type: integer
nullable: true
example: 4567890
total_youtube_subscribers:
type: integer
nullable: true
example: 3456789
required:
- results
creatorConnect:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
minItems: 1
items:
type: object
description: |
Depending on the partner, the report may contain different set of properties.
properties:
Category:
type: string
nullable: true
example: '"Science & Technology","News"'
CIQId:
type: integer
description: Creator Id in CIQ
example: 52717781
City:
type: string
nullable: true
example: Los Angeles
Country:
type: string
example: United States
CustomValue1:
type: string
nullable: true
example: 'Children: - | Phone Type: - | Political Affiliation: - | Content Rating: -'
CustomValue2:
type: string
nullable: true
example: '-'
CustomValue3:
type: string
nullable: true
example: '-'
CustomValue4:
type: string
nullable: true
example: '-'
CustomValue5:
type: string
nullable: true
example: '-'
CustomValue6:
type: string
nullable: true
example: '-'
CustomValue7:
type: string
nullable: true
example: '-'
CustomValue8:
type: string
nullable: true
example: '-'
CustomValue9:
type: string
nullable: true
example: '-'
CustomValue10:
type: string
nullable: true
example: '-'
CustomValue11:
type: string
nullable: true
example: '-'
CustomValue12:
type: string
nullable: true
example: '-'
CustomValue13:
type: string
nullable: true
example: '-'
CustomValue14:
type: string
nullable: true
example: '-'
CustomValue15:
type: string
nullable: true
example: '-'
CustomValue16:
type: string
nullable: true
example: '-'
CustomValue17:
type: string
nullable: true
example: '-'
DateJoinedPortal:
type: string
format: date
example: '2022-04-11'
DateOfBirth:
type: string
nullable: true
format: date
example: '1990-01-01'
DateOfBirthFormatted:
type: string
nullable: true
description: Date of Birth in MM-DD-YYYY format
example: 12-31-1990
DatePublisherStateChanged:
type: string
format: date
example: '2022-04-11'
Email:
type: string
nullable: true
format: email
example: john.doe@example.com
Email1:
type: string
nullable: true
format: email
example: john.doe2@example.com
EthnicBackground:
type: string
nullable: true
example: Hispanic/Latino
FlagshipAccountURL:
type: string
nullable: true
description: URL of main social account in publisher
format: URI
example: 'https://www.instagram.com/johndoe22222/'
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: '@johndoe22222'
FlagshipPropertyTitle:
type: string
nullable: true
description: Title of main social account in publisher
example: '@johndoe22222'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- behance
- blog
- broadcast
- douyin
- facebook
- google
- instagram
- line
- linkedin
- musical.ly
- pinterest
- podcast
- reddit
- snapchat
- tiktok
- tumblr
- twitch
- twitter
- web
- weibo
- youtube
- null
description: Main social network for publisher
example: youtube
Full Name:
type: string
example: John Doe
Gender:
type: string
example: Female
LastPortalLoginDate:
type: string
format: date-time
example: '2023-01-23 09:49:57'
LastPortalLoginEmail:
type: string
format: email
example: john.doe@example.com
LogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://social-pictures-storage.s3.amazonaws.com/thumb_f60bb277b588e9dc652f2abe8197864457257.jpeg'
NetworkPublisherId:
type: integer
example: 54868825665
PhoneNumber:
type: string
nullable: true
example: '0111111111111'
PublisherId:
type: integer
example: 72537585
PublisherName:
type: string
example: John Doe
PublisherTags:
type: string
nullable: true
example: 'Tag1,Tag2,Tag3'
RegistrationStatus:
type: string
example: Complete
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example: 'instagram103892434426157john.doe.ig100john.doe.ig14John Doe2022-07-18T13:28:34000102022-10-20T08:44:24.1472023-03-01T16:35:33
'
State:
type: string
nullable: true
example: California
Status:
type: string
example: Active
StatusCategory:
type: string
example: In Network
StreetAddress:
type: string
nullable: true
example: Some address
StreetAddress2:
type: string
nullable: true
example: Some address line 2
SubLeadSource:
type: string
nullable: true
example: SomeSource
TCPPDate:
type: string
nullable: true
example: '2022-11-17 15:08:31.0000000 +00:00'
ZipCode:
type: string
nullable: true
example: '01000'
required:
- results
publishersList:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
minItems: 1
items:
type: object
properties:
PublisherId:
type: integer
example: 572571
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://social-pictures-storage.s3.amazonaws.com/medium_f60bb277b588e9dc652f2abe8197864457257.jpeg'
ThumbLogoURL:
type: string
description: Publisher Logo URL with reduced size
format: URI
example: 'https://social-pictures-storage.s3.amazonaws.com/thumb_f60bb277b588e9dc652f2abe8197864457257.jpeg'
PublisherName:
type: string
example: John Doe
Email:
type: string
nullable: true
format: email
example: john.doe@example.com
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: '@johndoe22222'
FlagshipPropertyTitle:
type: string
nullable: true
description: Title of main social account in publisher
example: '@johndoe22222'
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: youtube
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example: 'instagram103892434426157john.doe.ig100john.doe.ig14John Doe2022-07-18T13:28:34000102022-10-20T08:44:24.1472023-03-01T16:35:33
'
YT_Subscribers:
type: integer
example: 7572
YT_AverageMonthlyViews:
type: number
example: 4365757257.72725
Status:
type: string
example: Open
StatusCategory:
type: string
example: In process
required:
- PublisherId
required:
- results
oneSheetBuilder:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 61461
PublisherName:
type: string
example: Aircooler
LogoURL:
type: string
description: Publisher Logo URL
format: URI
example: 'https://site.with/publisherLogoUrl.png'
SalesSheetLogoURL:
type: string
description: OneSheet Logo URL
format: URI
example: 'https://site.with/oneSheetLogoUrl.png'
Description:
type: string
example: Publisher's description
Tags:
type: string
nullable: true
description: Comma-separated list of Tags
example: '"gaming","xbox","ps4"'
Category:
type: string
example: '"Gaming"'
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
example: aircooler
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
example: twitch
FlagshipPropertyTitle:
type: string
nullable: true
description: Title of main social account in publisher
example: Air Cooler
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example: 'youtubeUCz0ZQtO9CsC1WYIixZiKRRR@aircooler120Air Cooler9260001002023-02-22T15:30:00
'
Metrics:
type: string
example: '[{"Network":"twitch","Followers":1037269,"EngagementRate":null,"TotalPosts":null,"TotalViews":8181098,"TotalLikes":null}]'
CommentsCount:
type: integer
example: 0
TopMetrics:
type: string
nullable: true
example: '[{"network":"Youtube","field":"Followers","label":"subscribers"}]'
TotalSubscribers:
type: integer
example: 3042857
OneSheetTopMetrics:
type: string
nullable: true
example: '{"Template":"SalesSheet","CreatedFromCampaign":false,"Sections":{"Youtube":1,"Twitter":1,"Facebook":1,"Instagram":1,"Google":1,"Vine":1,"Tumblr":0,"Pinterest":0,"Snapchat":0,"Web":0,"Audience":1,"Categories":1,"Tags":1,"PersonalData":1,"FeaturedVideos":1,"SponsoredVideos":1,"Description":1,"ShortDescription":1},"TopMetrics":[{"network":"Youtube","field":"Followers","label":"subscribers"},{"network":"Facebook","field":"Followers","label":"likes"}]}'
Approved:
type: boolean
nullable: true
example: true
Sections:
type: string
nullable: true
example: '{"Tumblr":1,"Pinterest":1,"Snapchat":1,"Web":1,"Audience":0,"FeaturedVideos":0,"SponsoredVideos":0,"ShortDescription":0,"Categories":0,"Tags":0}'
SortOrder:
type: integer
example: 1
UpdatedAt:
type: string
nullable: true
example: '2023-02-01 10:49:22'
CreatedAt:
type: string
nullable: true
example: '2023-02-01 10:49:22'
IsFeatured:
type: boolean
nullable: true
example: false
Linked:
type: integer
enum:
- 0
- 1
example: 1
Unlinked:
type: integer
nullable: true
enum:
- 0
- 1
- null
example: 1
LinkBroken:
type: integer
enum:
- 0
- 1
example: 1
Verified:
type: integer
nullable: true
enum:
- 0
- 1
- null
example: 1
SocialMetrics:
type: string
example: '[{"Id":25520593,"Network":"twitch","SocialNetworkId":"178238725","NetworkUser":"aircool","Followers":1037269,"NumberOfPosts":null}]'
SalesSheetsPublisherId:
type: integer
example: 11111
required:
- PublisherId
- PublisherName
required:
- results
CJAccountsReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CIQPublisherId:
type: integer
example: 61461
CJPublisherId:
type: integer
example: 35435
type:
type: string
example: Channel
CIQAccountId:
type: integer
example: 35785
CJPropertyId:
type: string
example: John Carpenter
Channel:
type: array
items:
type: object
properties:
ChannelId:
type: integer
description: Internal unique Id
format: int32
example: 17982764
ChannelName:
type: string
description: Channel name in Youtube
example: ZendayaVEVO
Channel:
type: string
description: Channel ID in Youtube
example: UCVQ2Z9dNQ2aJJ10f6SgBH0g
Title:
type: string
description: Channel title in Youtube
example: ZendayaVEVO
LogoURL:
type: string
description: Link to logo
example: 'https://yt3.ggpht.com/ytc/AMLnZu84MgVNNeswv0Vwz4IJzSilI_qQkx1JIRXsqrNvYw=s800-c-k-c0x00ffffff-no-rj-mo'
Summary:
type: string
nullable: true
default: null
PublisherId:
type: integer
description: Id of publisher which attached to Youtube channel
format: int32
example: 9202903
NetworkId:
type: integer
description: Id of partner
format: int32
example: 141
Category:
type: string
nullable: true
description: Category of channel
default: null
Status:
type: string
description: Status of publisher in network
example: Open - In process
DateActivated:
type: string
nullable: true
default: null
YTLanguage:
type: string
nullable: true
description: Language of youtube channel
example: English
YTGeoRegion:
type: string
example: US
YTGender:
type: string
nullable: true
default: null
CustomTag1:
type: string
nullable: true
default: null
CustomTag2:
type: string
nullable: true
default: null
CustomTag3:
type: string
nullable: true
default: null
CustomField1:
type: string
nullable: true
default: null
CustomValue1:
type: string
nullable: true
default: null
CustomField2:
type: string
nullable: true
default: null
CustomValue2:
type: string
nullable: true
default: null
CustomField3:
type: string
nullable: true
default: null
CustomValue3:
type: string
nullable: true
default: null
ContentOwner:
type: string
example: Admin
TotalSubscribers:
type: integer
description: Count of subscribers for this channel
format: int32
example: 1310000
TotalViews:
type: string
description: Count of views channel
example: '390807217'
TotalVideos:
type: integer
description: Count of videos channel
format: int32
example: 35
CreateDateTime:
type: string
description: Date-time when channel created
example: '2014-02-13T03:40:11'
LastUpdated:
type: string
description: Date-time when channel last updated
example: '2014-02-13T03:40:11'
UpdatedBy:
type: string
description: Channel updated by
example: Discovery
NotFound:
type: boolean
description: Is channel not found
example: false
AverageMonthlyViews:
type: number
nullable: true
description: Average Monthly Views
example: 125173.49152542
AvgLastViewsPerVideo:
type: number
nullable: true
description: Avg Last Views Per Video
example: 125173.49152542
AvgLastCommentsPerVideo:
type: number
nullable: true
description: Avg Last Comments Per Video
example: 125173.49152542
AvgLastLikesPerVideo:
type: number
nullable: true
description: Avg Last Likes Per Video
example: 125173.49152542
AvgLastDislikesPerVideo:
type: number
nullable: true
description: Avg Last Dislikes Per Video
example: 125173.49152542
AvgLastSharesPerVideo:
type: number
nullable: true
description: Avg Last Shares Per Video
example: 125173.49152542
AvgLastTwitterSharesPerVideo:
type: number
nullable: true
description: Avg Last Twitter Shares Per Video
example: 125173.49152542
StatusChangedManually:
type: boolean
description: Is status changed manually
example: false
TotalLikes:
type: integer
nullable: true
description: Total likes
example: 20
TotalDislikes:
type: integer
nullable: true
description: Total dislikes
example: 20
TotalComments:
type: integer
nullable: true
description: Total comments
example: 20
IncludeInContract:
type: boolean
description: Is include in contract
example: true
Protected:
type: boolean
description: Is protected
example: true
AvgLastPinterestSharesPerVideo:
type: number
nullable: true
description: Avg Last Pinterest Shares Per Video
example: 125173.49152542
DateDeActivated:
type: string
nullable: true
description: Date-time when channel was deactivated
example: '2014-02-13T03:40:11'
DateStatusChanged:
type: string
nullable: true
description: Date-time when status changed
example: '2014-02-13T03:40:11'
LogoHighResURL:
type: string
nullable: true
description: Logo url
example: 'https://yt3.ggpht.com/ytc/AIdro_n0Alr6iBFQwLS24pDhFCmTL1LMUP4XhUc7yI_4-CRKqGo=s88-c-k-c0x00ffffff-no-rj'
CreatedBy:
type: string
description: Channel created by
example: John Doe
CreatedAt:
type: string
description: Date-time when channel created at
example: '2014-02-13T03:40:11'
CreatorRole:
type: string
description: Channel creator role
example: Account owner
VerifiedBy:
type: string
nullable: true
description: Channel verified by
example: John Doe
LinkedBy:
type: string
nullable: true
description: Channel linked by
example: John Doe
LinkedAt:
type: string
nullable: true
description: Date-time when channel linked at
example: '2014-02-13T03:40:11'
ApiToken:
type: string
nullable: true
description: Api token
example: Br2131243243kmfslekfmekf1432432432kmdmseaedf
isVerifiedBySocialNetwork:
type: integer
enum:
- 0
- 1
description: is Verified By Social Network
example: 1
IsTokenInvalid:
type: integer
enum:
- 0
- 1
description: Is Token Invalid
example: 1
TokenInvalidDate:
type: string
nullable: true
description: Date-time when token invalid
example: '2014-02-13T03:40:11'
DateAnalytics:
type: string
nullable: true
description: Date-time of analytics
example: '2014-02-13T03:40:11'
NewSocialAccountID:
type: number
description: New social account id
example: -733557
Network:
type: string
description: Network name
example: youtube
SocialNetworkId:
type: string
description: Social network id
example: UCI8AQqkapE9K6pd8aK71B7w
NetworkUser:
type: string
description: Social handle
example: joshdarnit
NumberOfPosts:
type: integer
description: Number of posts
example: 362
DateSocialStatsUpdated:
type: string
nullable: true
description: Date-time of social stats updated
example: '2014-02-13T03:40:11'
Contracts:
type: object
properties:
type:
type: string
description: Contracts type
example: ContractCollection
Linked:
type: integer
enum:
- 0
- 1
description: Is linked
example: 1
Unlinked:
type: integer
enum:
- 0
- 1
description: Is unlinked
example: 1
LinkBroken:
type: integer
enum:
- 0
- 1
description: Is link broken
example: 1
Verified:
type: integer
enum:
- 0
- 1
description: Is Verified
example: 1
Business:
type: integer
nullable: true
enum:
- 0
- 1
- null
description: Is Verified
example: 1
SocialEngagement:
type: array
items:
$ref: '#/components/schemas/SocialEngagement'
Social:
type: array
items:
type: object
properties:
Id:
type: integer
description: Social id
example: 17982764
PublisherId:
type: integer
description: Publisher ID which attached to social account
example: 4630799
Network:
type: string
description: Network name
example: instagram
SocialNetworkId:
type: string
description: Social network id
example: amandamurakamy2
NetworkUser:
type: string
description: Social handle
example: amandamurakamy2
ApiToken:
type: string
nullable: true
description: Api token
example: Br2131243243kmfslekfmekf1432432432kmdmseaedf
Followers:
type: string
description: Followers count
example: '10'
DateSocialStatsUpdated:
type: string
nullable: true
description: Date-time when social stats updated
example: '2014-02-13T03:40:11'
LastUpdated:
type: string
description: Date-time when social last updated
example: '2014-02-13T03:40:11'
UpdatedBy:
type: string
description: Social updated by
example: Discovery
NotFound:
type: boolean
description: Is social not found
example: false
Protected:
type: boolean
description: Is protected
example: true
NetworkId:
type: integer
description: Id of partner
example: 141
NumberOfPosts:
type: integer
description: Number of posts
example: 362
EngagementPercentage:
type: number
nullable: true
description: Engagement Percentage
example: 0.42
TotalComments:
type: integer
nullable: true
description: Total comments
example: 20
TotalLikes:
type: integer
nullable: true
description: Total likes
example: 20
LastPostDate:
type: string
nullable: true
description: Date-time when last post published
example: '2014-02-13T03:40:11'
LogoURL:
type: string
description: Link to logo
example: 'https://static-resources.creatoriq.com/social-pictures/instagram/thumbnail/amandamurakamy.jpg'
ThumbnailURL:
type: string
description: Link to thumbnail
example: 'https://static-resources.creatoriq.com/social-pictures/instagram/thumbnail/amandamurakamy.jpg'
Location:
type: string
nullable: true
description: Location name
example: New York
Gender:
type: string
nullable: true
description: Gender
default: null
AvgCommentsPerPost:
type: number
nullable: true
description: Avg Comments per post
example: 125173.4
AvgLastLikesPerPost:
type: number
nullable: true
description: Avg Likes Per Post
example: 125173.4
AvgSharesPerVideo:
type: number
nullable: true
description: Avg Shares Per Post
example: 125173.4
TotalViews:
type: integer
nullable: true
description: Count of views social
example: 390807217
CreatedBy:
type: string
description: Social created by
example: John Doe
CreatedAt:
type: string
description: Date-time when social created at
example: '2014-02-13T03:40:11'
CreatorRole:
type: string
description: Social creator role
example: Account owner
VerifiedBy:
type: string
nullable: true
description: Social verified by
example: John Doe
LinkedBy:
type: string
nullable: true
description: Social linked by
example: John Doe
LinkedAt:
type: string
nullable: true
description: Date-time when social linked at
example: '2014-02-13T03:40:11'
MonthlyUniqueVisitors:
type: integer
nullable: true
description: Number of unique monthly visitors
example: 500
Bio:
type: string
nullable: true
description: Description of the social account
example: Sejam bem-vindos!\nUma bagunça organizada
AvgViewsPerVideo:
type: number
nullable: true
description: Avg Views Per Post
example: 125173.4
MonthlyVisitors:
type: integer
nullable: true
description: Number of monthly visitors
example: 500
AvgTimeSpentOnPost:
type: number
nullable: true
description: Avg Time Spent On Post
example: 125173.4
Language:
type: string
nullable: true
description: Language
example: EN
NumberFollowing:
type: integer
nullable: true
description: Count of following
example: 390807217
FullName:
type: string
description: Full name of account
example: Amanda Murakami
IsTokenInvalid:
type: integer
enum:
- 0
- 1
description: Is Token Invalid
example: 1
WebSessions:
type: integer
nullable: true
description: Web sessions count
example: 390807217
PageViews:
type: integer
nullable: true
description: Social views count
example: 390807217
ViewsPerSession:
type: integer
nullable: true
description: Views per session count
example: 390807217
SessionDuration:
type: integer
nullable: true
description: Session duration
example: 390807217
ThreeMonthAverageVisitors:
type: number
nullable: true
description: Avg visitors of three month
example: 125173.4
ThreeMonthAverageViewsPerSession:
type: number
nullable: true
description: Avg views per session of three month
example: 125173.4
ThreeMonthAverageSessionDuration:
type: number
nullable: true
description: Avg session duration of three of three month
example: 125173.4
GaProfile:
type: string
nullable: true
description: Ga profile
default: null
IGFBAccessToken:
type: string
nullable: true
description: IG FB access token
example: EAAG38GadgKoBACHq9yrqbTiPEaCZCv1ZAYx6gmo1ZCn28ApnlK7AqZA48eNseXV4yXA3AtWxvP9SDkW6eMmzuhypfkdQqaVPZARZAZCTBs47tpJ7Ep2nsC4ff4JJl1InrjRlms8OLaHvVEU0lESUqkKZAhDM3NBUowlRZAKrvCNhatIZCLSHhIa1BbZCG0HPKM3daww2
isVerifiedBySocialNetwork:
type: integer
nullable: true
enum:
- 0
- 1
- null
description: is Verified By Social Network
example: 1
IsBusiness:
type: integer
nullable: true
enum:
- 0
- 1
- null
description: Is account business
example: 1
TokenInvalidDate:
type: string
nullable: true
description: Date-time when token invalid
example: '2014-02-13T03:40:11'
IGFBId:
type: string
nullable: true
description: IG FB id
example: '17841401408454960'
Stories:
type: string
nullable: true
description: Stories
default: null
StoriesViewCount:
type: integer
nullable: true
description: Stories view count
example: 123
NewSocialAccountID:
type: number
description: New social account id
example: -733557
PeakStreamConcurrentViews:
type: integer
nullable: true
description: Stream views count
example: 123
AvgStreamConcurrentViews:
type: number
nullable: true
description: Stream views count
example: 123.4
Subscribers:
type: integer
description: Count of subscribers for this social
example: 1310000
VideoDuration:
type: integer
nullable: true
description: Video duration
example: 213412
EstimatedUniqueStreamViews:
type: integer
nullable: true
description: Estimated Unique Stream Views
example: 123
ViewsVideoCount:
type: integer
nullable: true
description: Views Video Count
example: 123
Linked:
type: integer
enum:
- 0
- 1
description: is Linked
example: 1
Unlinked:
type: integer
enum:
- 0
- 1
description: is unLinked
example: 1
LinkBroken:
type: integer
enum:
- 0
- 1
description: is Link broken
example: 1
Verified:
type: integer
nullable: true
enum:
- 0
- 1
- null
description: Is Verified
example: 1
Business:
type: integer
nullable: true
enum:
- 0
- 1
- null
description: Is Verified
WhitelistingExpirationDate:
type: string
nullable: true
description: Date-time when whitelisting will be expired
example: '2014-02-13T03:40:11'
VideoInformation:
type: object
properties:
TotalViews:
type: integer
nullable: true
description: Count of video views
example: 390807217
TotalVideos:
type: integer
nullable: true
description: Count of total videos count
example: 390807217
TotalLikes:
type: integer
nullable: true
description: Count of total likes
example: 390807217
TotalShares:
type: integer
nullable: true
description: Count of total shares
example: 390807217
TotalViewsOrganic:
type: integer
nullable: true
description: Count of total organic views
example: 390807217
TotalViewsPaid:
type: integer
nullable: true
description: Count of total paid views
example: 390807217
TotalViewsUnique:
type: integer
nullable: true
description: Count of total unique views
example: 390807217
AverageMonthlyViews:
type: number
nullable: true
description: Average Monthly Views
example: 123
AvgLastViewsPerVideo:
type: number
nullable: true
description: Average last views per video
example: 123
AvgLastCommentsPerVideo:
type: number
nullable: true
description: Avg last comments per video
example: 123
AvgLastLikesPerVideo:
type: number
nullable: true
description: Avg last likes per video
example: 123
AvgLastSharesPerVideo:
type: number
nullable: true
description: Avg last shares per video
example: 123
AvgLastMinutesWatchedPerVideo:
type: number
nullable: true
description: Avg last minutes watched per video
example: 123
SocialEngagement:
type: array
items:
$ref: '#/components/schemas/SocialEngagement'
required:
- CIQPublisherId
- CJPublisherId
- type
- CIQAccountId
- CJPropertyId
required:
- results
SocialEngagement:
type: object
properties:
EngagementRate30Days:
type: string
nullable: true
example: ''
EngagementRate60Days:
type: string
nullable: true
example: ''
EngagementRate90Days:
type: number
nullable: true
example: 0.0061
EngagementRate20Posts:
type: number
nullable: true
example: 0.0202
EngagementRateLifetime:
type: number
nullable: true
example: 0.007
EngagementCalculated:
type: string
description: 'Timestamp of the most recent run of the engagement-metrics aggregation job for this account (calculates per-post and rolling-window engagement rates). Driven by its own background job on a different schedule from `LastUpdated` and `DateSocialStatsUpdated`, so the three timestamps can legitimately differ for the same account — some divergence between these timestamps is expected and does not indicate stale data.'
format: date-time
example: '2015-06-26 22:46:50'
PostsCount30Days:
type: number
nullable: true
example: 86705
PostsCount60Days:
type: number
nullable: true
example: 86705
PostsCount90Days:
type: number
nullable: true
example: 86705
PostsCountLifetime:
type: number
nullable: true
example: 86705
LastPostDate:
type: string
description: Unique youtube account id
format: date-time
example: '2015-06-26 22:46:50'
AVV30:
type: integer
nullable: true
example: 86705
AVV60:
type: integer
nullable: true
example: 86705
AVV90:
type: integer
nullable: true
example: 86705
ID:
type: number
example: 509137
AccountSource:
type: string
example: ''
Engagement30Days:
type: number
example: 86705
Engagement60Days:
type: number
example: 86705
Engagement90Days:
type: number
example: 86705
Engagement20Posts:
type: number
example: 86705
EngagementLifetime:
type: number
example: 86705
SharesPerPost30Days:
type: number
nullable: true
example: 86705
SharesPerPost60Days:
type: number
nullable: true
example: 86705
SharesPerPost90Days:
type: number
nullable: true
example: 86705
SharesPerPost20Posts:
type: number
nullable: true
example: 86705
SharesPerPostLifetime:
type: number
nullable: true
example: 86705
LikesPerPost30Days:
type: number
nullable: true
example: 86705
LikesPerPost60Days:
type: number
nullable: true
example: 86705
LikesPerPost90Days:
type: number
nullable: true
example: 86705
LikesPerPost20Posts:
type: number
nullable: true
example: 14233.65
LikesPerPostLifetime:
type: number
nullable: true
example: 3407.2684
CommentsPerPost30Days:
type: number
nullable: true
example: 86705
CommentsPerPost60Days:
type: number
nullable: true
example: 86705
CommentsPerPost90Days:
type: number
nullable: true
example: 527
CommentsPerPost20Posts:
type: number
nullable: true
example: 832.55
CommentsPerPostLifetime:
type: number
nullable: true
example: 90.8368
ViewsPerPost30Days:
type: number
nullable: true
example: 527
ViewsPerPost60Days:
type: number
nullable: true
example: 527
ViewsPerPost90Days:
type: number
nullable: true
example: 86705
ViewsPerPost20Posts:
type: number
nullable: true
example: 747087.15
ViewsPerPostLifetime:
type: number
nullable: true
example: 497148.1421
DisLikesPerPost30Days:
type: number
nullable: true
example: 547
DisLikesPerPost60Days:
type: number
nullable: true
example: 547
DisLikesPerPost90Days:
type: number
nullable: true
example: 547
DisLikesPerPost20Posts:
type: number
nullable: true
example: 547
DisLikesPerPostLifetime:
type: number
nullable: true
example: 547
CloseUpsPerPost30Days:
type: number
nullable: true
example: 547
CloseUpsPerPost60Days:
type: number
nullable: true
example: 547
CloseUpsPerPost90Days:
type: number
nullable: true
example: 547
CloseUpsPerPost20Posts:
type: number
nullable: true
example: 547
CloseUpsPerPostLifetime:
type: number
nullable: true
example: 547
ImpressionsPerPost30Days:
type: string
nullable: true
example: ''
ImpressionsPerPost60Days:
type: number
nullable: true
example: 547
ImpressionsPerPost90Days:
type: number
nullable: true
example: 547
ImpressionsPerPost20Posts:
type: number
nullable: true
example: 547
ImpressionsPerPostLifetime:
type: number
nullable: true
example: 547
ClicksPerPost30Days:
type: number
nullable: true
example: 547
ClicksPerPost60Days:
type: number
nullable: true
example: 547
ClicksPerPost90Days:
type: number
nullable: true
example: 547
ClicksPerPost20Posts:
type: number
nullable: true
example: 547
ClicksPerPostLifetime:
type: number
nullable: true
example: 547
SavesPerPost30Days:
type: number
nullable: true
example: 547
SavesPerPost60Days:
type: number
nullable: true
example: 547
SavesPerPost90Days:
type: number
nullable: true
example: 547
SavesPerPost20Posts:
type: number
nullable: true
example: 547
SavesPerPostLifetime:
type: number
nullable: true
example: 547
ReachRate30days:
type: number
nullable: true
example: 547
ReachRate60days:
type: number
nullable: true
example: 547
ReachRate90days:
type: number
nullable: true
example: 547
ReachRate20posts:
type: number
nullable: true
example: 547
ReachRateLifetime:
type: number
nullable: true
example: 547
SavesPerVideo30Days:
type: number
nullable: true
example: 547
SavesPerVideo60Days:
type: number
nullable: true
example: 547
SavesPerVideo90Days:
type: number
nullable: true
example: 547
SavesPerVideo20Posts:
type: number
nullable: true
example: 547
SavesPerVideoLifetime:
type: number
nullable: true
example: 547
ClicksPerVideo30Days:
type: number
nullable: true
example: 547
ClicksPerVideo60Days:
type: number
nullable: true
example: 547
ClicksPerVideo90Days:
type: number
nullable: true
example: 547
ClicksPerVideo20Posts:
type: number
nullable: true
example: 547
ClicksPerVideoLifetime:
type: number
nullable: true
example: 547
ImpressionsRate30days:
type: number
nullable: true
example: 547
ImpressionsRate60days:
type: number
nullable: true
example: 547
ImpressionsRate90days:
type: number
nullable: true
example: 547
ImpressionsRate20posts:
type: number
nullable: true
example: 547
ImpressionsRatelifetime:
type: number
nullable: true
example: 547
ReachPerPost30days:
type: number
nullable: true
example: 547
ReachPerPost60days:
type: number
nullable: true
example: 547
ReachPerPost90days:
type: number
nullable: true
example: 547
ReachPerPost20posts:
type: number
nullable: true
example: 547
ReachPerPostlifetime:
type: number
nullable: true
example: 547
AvgStreamPeakViews30Days:
type: number
nullable: true
example: 547
AvgStreamPeakViews60Days:
type: number
nullable: true
example: 547
AvgStreamPeakViews90Days:
type: number
nullable: true
example: 547
AvgStreamPeakViews20Posts:
type: number
nullable: true
example: 547
AvgStreamAverageViews30Days:
type: number
nullable: true
example: 547
AvgStreamAverageViews60Days:
type: number
nullable: true
example: 547
AvgStreamAverageViews90Days:
type: number
nullable: true
example: 547
AvgStreamAverageViews20Posts:
type: number
nullable: true
example: 547
IsHiddenLike30Days:
type: number
nullable: true
example: 547
IsHiddenLike60Days:
type: number
nullable: true
example: 547
IsHiddenLike90Days:
type: number
nullable: true
example: 547
IsHiddenLike20Posts:
type: number
nullable: true
example: 547
MedianViews20Posts:
type: number
nullable: true
example: 547
CouponCodePayouts:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 61461
PublisherName:
type: string
example: Aircooler
LogoURL:
type: string
nullable: true
description: Publisher Logo URL
format: URI
example: 'https://site.with/publisherLogoUrl.png'
FlagshipProperty:
type: string
nullable: true
description: Main social account handle of publisher
maxLength: 1024
example: greatdad
FlagshipSocialNetwork:
type: string
nullable: true
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
- null
description: Main social network for publisher
default: web
example: twitch
SocialAccountsList:
type: string
nullable: true
description: XML representation of publisher's Social Accounts
example:
Coupon:
type: string
nullable: true
description: Coupon code value
example: LIVE21PAYABLE
CommissionCurrency:
type: string
nullable: true
enum:
- USD
- GBP
- EUR
- CAD
- AUD
- BRL
- CZK
- DKK
- AED
- HKD
- HUF
- ILD
- INR
- JPY
- MYR
- MXN
- NZD
- PHP
- PLN
- RUB
- SAR
- SGD
- SEK
- CHF
- TWD
- THB
- I
- ZAR
- KRW
- RON
- TRY
- IDR
- null
description: Currency
default: USD
example: USD
SaleAmount:
type: number
nullable: true
description: Sale amount
example: 121.3
Commission:
type: number
nullable: true
description: Commission amount
example: 6.07
ComissionAmountApproved:
type: number
nullable: true
description: Commission amount which was approved
example: 6.07
ComissionAmountPending:
type: number
nullable: true
description: Commission amount which is pending
example: 6.07
ComissionAmountDeclined:
type: number
nullable: true
description: Commission amount which was declined
example: 6.07
TransactionAmountApproved:
type: integer
nullable: true
description: Transaction amount which was approved
example: 6
TransactionAmountPending:
type: integer
nullable: true
description: Transaction amount which is pending
example: 6
TransactionAmountDeclined:
type: integer
nullable: true
description: Transaction amount which was declined
example: 6
AmountPaid:
type: number
nullable: true
description: Amount which was paid
example: 6.07
ApprovedPendingPayment:
type: number
nullable: true
description: Payment which was approved but not paid yet
example: 6.07
RowId:
type: string
nullable: true
description: Row identified
example: '61461:LIVE21PAYABLE'
required:
- PublisherId
- PublisherName
required:
- results
TransactionsReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
PublisherId:
type: integer
example: 61461
PublisherName:
type: string
example: Aircooler
Email:
type: string
nullable: true
description: Creator's email
format: email
example: test@mail.com
CampaignName:
type: string
nullable: true
description: Campaign name
example: Campaign name
TransactionDateTime:
type: string
nullable: true
description: Datetime when transaction was made
example: '2021-07-27 18:41:48'
TransactionDate:
type: string
nullable: true
description: Date when transaction was made
example: '2021-07-27'
TransactionId:
type: string
nullable: true
description: Transaction identifier
example: test_820e681a
OrderId:
type: string
nullable: true
description: Order identifier
example: '123456'
SaleAmount:
type: number
nullable: true
description: Sale amount
example: 0.2
ComissionAmount:
type: number
nullable: true
description: Comission amount
example: 0.02
Status:
type: string
nullable: true
description: Status of transaction
example: APPROVED
Promocode:
type: string
nullable: true
description: Promocode
example: Live21Pay
Link:
type: string
nullable: true
description: Link to transaction
example: 'https://bit.ly/3OvQ9Al'
Clicks:
type: integer
nullable: true
description: Clicks count
example: 1
SaleCurrency:
type: string
nullable: true
enum:
- USD
- GBP
- EUR
- CAD
- AUD
- BRL
- CZK
- DKK
- AED
- HKD
- HUF
- ILD
- INR
- JPY
- MYR
- MXN
- NZD
- PHP
- PLN
- RUB
- SAR
- SGD
- SEK
- CHF
- TWD
- THB
- I
- ZAR
- KRW
- RON
- TRY
- IDR
- null
description: Sale currency
default: USD
example: USD
CommissionCurrency:
type: string
nullable: true
enum:
- USD
- GBP
- EUR
- CAD
- AUD
- BRL
- CZK
- DKK
- AED
- HKD
- HUF
- ILD
- INR
- JPY
- MYR
- MXN
- NZD
- PHP
- PLN
- RUB
- SAR
- SGD
- SEK
- CHF
- TWD
- THB
- I
- ZAR
- KRW
- RON
- TRY
- IDR
- null
description: Commission currency
default: USD
example: USD
required:
- PublisherId
- PublisherName
required:
- results
1CampaignsDetails:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
CampaignId:
type: integer
example: 1810270
LogoURL:
type: string
nullable: true
description: Campaign logo URL
example: 'https://somestorage.com/picture.png'
ThumbLogoURL:
type: string
nullable: true
description: Campaign thumb URL
example: 'https://somestorage.com/picture.png'
CampaignName:
type: string
description: Campaign name
example: Campaign Number One
AdvertiserName:
type: string
description: Name of advertiser
example: Brand
CampaignStatus:
type: string
nullable: true
description: Status of campaign
example: Active
Currency:
type: string
nullable: true
enum:
- USD
- GBP
- EUR
- CAD
- AUD
- BRL
- CZK
- DKK
- AED
- HKD
- HUF
- ILD
- INR
- JPY
- MYR
- MXN
- NZD
- PHP
- PLN
- RUB
- SAR
- SGD
- SEK
- CHF
- TWD
- THB
- I
- ZAR
- KRW
- RON
- TRY
- IDR
- null
description: Sale currency
default: USD
example: USD
TotalBudget:
type: number
nullable: true
description: Total budget of campaign
example: 4000
StartDate:
type: string
nullable: true
description: Date when campaign start
example: '2021-07-27'
EndDate:
type: string
nullable: true
description: Date when campaign end
example: '2021-08-27'
Description:
type: string
nullable: true
description: Description of campaign
example: Some description of campaign
SalesPerson:
type: string
nullable: true
description: Sales person
example: Some Manager
Visibility:
type: string
nullable: true
description: How campaign is visible
example: By invitation only
NumberOfPublishers:
type: integer
description: Number of publishers in Campaign
example: 5
NumberOfVideos:
type: integer
description: Number of videos in Campaign
example: 0
NumberOfPosts:
type: integer
description: Number of posts in Campaign
example: 10
Views:
type: integer
description: Number of views in Campaign
example: 20
Manager:
type: string
nullable: true
description: Manager of Campaign
example: John Doe
AccountManagerName:
type: string
nullable: true
description: Account manager name
example: John Doe
DateLastActivityUpdated:
type: string
nullable: true
description: Date when campaign was updated
example: '2021-08-16 05:35:28'
CampaignUpdateFrequency:
type: integer
nullable: true
description: Frequency of campaign updating
example: 24
DivisionName:
type: string
nullable: true
description: Campaign division name
example: Division
required:
- CampaignId
- CampaignName
- AdvertiserName
required:
- results
InstagramFacebookReport:
type: object
allOf:
- $ref: '#/components/schemas/commonResponse'
- type: object
properties:
results:
type: array
items:
type: object
properties:
Brand:
type: string
description: Brand name
example: brandMedia
Campaign:
type: string
description: Campaign name
example: New Campaign
CampaignCost:
type: string
nullable: true
description: Campaign budget
example: $2000
Region:
type: string
nullable: true
description: Division name
example: Division
PublisherName:
type: string
description: Publisher name
example: John Doe
PublisherId:
type: integer
description: Publisher identifier
example: 1
Email:
type: string
nullable: true
description: Publisher email
example: test@mail.com
LogoURL:
type: string
nullable: true
description: Campaign logo URL
example: 'https://somestorage.com/picture.png'
ThumbLogoURL:
type: string
nullable: true
description: Campaign thumb URL
example: 'https://somestorage.com/picture.png'
Permalink:
type: string
description: Post link
example: 'https://social/post'
Platform:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
description: Social network
example: instagram
PostType:
type: string
description: Type of post
example: story
PostDate:
type: string
description: Date when post published
example: '2024-05-27'
TotalEngagement:
type: number
nullable: true
description: Total engagement
example: 10.01
EngagementRate:
type: number
nullable: true
description: Engagement rate
example: 1.01
Reach:
type: integer
nullable: true
description: Reach
example: 20
SMV:
type: integer
nullable: true
description: Social Media Value
example: 250
FollowersAtTimeOfPost:
type: integer
nullable: true
description: Followers at time of post
example: 30
Likes:
type: integer
nullable: true
description: Likes
example: 20
Comments:
type: integer
nullable: true
description: Comments
example: 20
Shares:
type: integer
nullable: true
description: Shares
example: 10
Saved:
type: integer
nullable: true
description: Saved
example: 10
Views:
type: integer
nullable: true
description: Views
example: 6
Clicks:
type: integer
nullable: true
description: Clicks
example: 5
Impressions:
type: integer
nullable: true
description: Impressions
example: 5
Agency/Source:
type: string
nullable: true
description: Agency/Source
example: source
Audience:
type: string
nullable: true
description: Audience
example: Audience|
Relationship:
type: string
nullable: true
description: Relationship
example: 'Relationship:'
PostStatus:
type: string
nullable: true
description: Post status
example: Actual
Post:
type: string
nullable: true
description: Post text
example: some text
required:
- results
security:
- apiKey: []