CreatorIQ CJ API

openapi: 3.2.0
info:
  version: 1.0.0
  title: CreatorIQ Reporting CJ API
  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
security:
- apiKey: []
tags:
- name: CJ
  description: CJ reports
paths:
  /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
components:
  schemas:
    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
    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
                        - 'null'
                        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
                        - 'null'
                        description: Category of channel
                        default: null
                      Status:
                        type: string
                        description: Status of publisher in network
                        example: Open - In process
                      DateActivated:
                        type:
                        - string
                        - 'null'
                        default: null
                      YTLanguage:
                        type:
                        - string
                        - 'null'
                        description: Language of youtube channel
                        example: English
                      YTGeoRegion:
                        type: string
                        example: US
                      YTGender:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomTag1:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomTag2:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomTag3:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomField1:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomValue1:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomField2:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomValue2:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomField3:
                        type:
                        - string
                        - 'null'
                        default: null
                      CustomValue3:
                        type:
                        - string
                        - 'null'
                        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
                        - 'null'
                        description: Average Monthly Views
                        example: 125173.49152542
                      AvgLastViewsPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Last Views Per Video
                        example: 125173.49152542
                      AvgLastCommentsPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Last Comments Per Video
                        example: 125173.49152542
                      AvgLastLikesPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Last Likes Per Video
                        example: 125173.49152542
                      AvgLastDislikesPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Last Dislikes Per Video
                        example: 125173.49152542
                      AvgLastSharesPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Last Shares Per Video
                        example: 125173.49152542
                      AvgLastTwitterSharesPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Last Twitter Shares Per Video
                        example: 125173.49152542
                      StatusChangedManually:
                        type: boolean
                        description: Is status changed manually
                        example: false
                      TotalLikes:
                        type:
                        - integer
                        - 'null'
                        description: Total likes
                        example: 20
                      TotalDislikes:
                        type:
                        - integer
                        - 'null'
                        description: Total dislikes
                        example: 20
                      TotalComments:
                        type:
                        - integer
                        - 'null'
                        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
                        - 'null'
                        description: Avg Last Pinterest Shares Per Video
                        example: 125173.49152542
                      DateDeActivated:
                        type:
                        - string
                        - 'null'
                        description: Date-time when channel was deactivated
                        example: '2014-02-13T03:40:11'
                      DateStatusChanged:
                        type:
                        - string
                        - 'null'
                        description: Date-time when status changed
                        example: '2014-02-13T03:40:11'
                      LogoHighResURL:
                        type:
                        - string
                        - 'null'
                        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
                        - 'null'
                        description: Channel verified by
                        example: John Doe
                      LinkedBy:
                        type:
                        - string
                        - 'null'
                        description: Channel linked by
                        example: John Doe
                      LinkedAt:
                        type:
                        - string
                        - 'null'
                        description: Date-time when channel linked at
                        example: '2014-02-13T03:40:11'
                      ApiToken:
                        type:
                        - string
                        - 'null'
                        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
                        - 'null'
                        description: Date-time when token invalid
                        example: '2014-02-13T03:40:11'
                      DateAnalytics:
                        type:
                        - string
                        - 'null'
                        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
                        - 'null'
                        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
                        - 'null'
                        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
                        - 'null'
                        description: Api token
                        example: Br2131243243kmfslekfmekf1432432432kmdmseaedf
                      Followers:
                        type: string
                        description: Followers count
                        example: '10'
                      DateSocialStatsUpdated:
                        type:
                        - string
                        - 'null'
                        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
                        - 'null'
                        description: Engagement Percentage
                        example: 0.42
                      TotalComments:
                        type:
                        - integer
                        - 'null'
                        description: Total comments
                        example: 20
                      TotalLikes:
                        type:
                        - integer
                        - 'null'
                        description: Total likes
                        example: 20
                      LastPostDate:
                        type:
                        - string
                        - 'null'
                        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
                        - 'null'
                        description: Location name
                        example: New York
                      Gender:
                        type:
                        - string
                        - 'null'
                        description: Gender
                        default: null
                      AvgCommentsPerPost:
                        type:
                        - number
                        - 'null'
                        description: Avg Comments per post
                        example: 125173.4
                      AvgLastLikesPerPost:
                        type:
                        - number
                        - 'null'
                        description: Avg Likes Per Post
                        example: 125173.4
                      AvgSharesPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Shares Per Post
                        example: 125173.4
                      TotalViews:
                        type:
                        - integer
                        - 'null'
                        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
                        - 'null'
                        description: Social verified by
                        example: John Doe
                      LinkedBy:
                        type:
                        - string
                        - 'null'
                        description: Social linked by
                        example: John Doe
                      LinkedAt:
                        type:
                        - string
                        - 'null'
                        description: Date-time when social linked at
                        example: '2014-02-13T03:40:11'
                      MonthlyUniqueVisitors:
                        type:
                        - integer
                        - 'null'
                        description: Number of unique monthly visitors
                        example: 500
                      Bio:
                        type:
                        - string
                        - 'null'
                        description: Description of the social account
                        example: Sejam bem-vindos!\nUma bagunça organizada
                      AvgViewsPerVideo:
                        type:
                        - number
                        - 'null'
                        description: Avg Views Per Post
                        example: 125173.4
                      MonthlyVisitors:
                        type:
                        - integer
                        - 'null'
                        description: Number of monthly visitors
                        example: 500
                      AvgTimeSpentOnPost:
                        type:
                        - number
                        - 'null'
                        description: Avg Time Spent On Post
                        example: 125173.4
                      Language:
                        type:
                        - string
                        - 'null'
                        description: Language
                        example: EN
                      NumberFollowing:
                        type:
                        - integer
                        - 'null'
                        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
                        - 'null'
                        description: Web sessions count
                        example: 390807217
                      PageViews:
                        type:
                        - integer
                        - 'null'
                        description: Social views count
                        example: 390807217
                      ViewsPerSession:
                        type:
                        - integer
                        - 'null'
                        description: Views per session count
                        example: 390807217
                      SessionDuration:
                        type:
                        - integer
                        - 'null'
                        description: Session duration
                        example: 390807217
                      ThreeMonthAverageVisitors:
                        type:
                        - number
                        - 'null'
                        description: Avg visitors of three month
                        example: 125173.4
                      ThreeMonthAverageViewsPerSession:
                        type:
                        - number
                        - 'null'
                        description: Avg views per session of three month
                        example: 125173.4
                      ThreeMonthAverageSessionDuration:
                        type:
                        - number
                        - 'null'
                        description: Avg session duration of three of three month
                        example: 125173.4
                      GaProfile:
                        type:
                        - string
                        - 'null'
                        description: Ga profile
                        default: null
                      IGFBAccessToken:
                        type:
                        - string
                        - 'null'
                        description: IG FB access token
                        example: EAAG38GadgKoBACHq9yrqbTiPEaCZCv1ZAYx6gmo1ZCn28ApnlK7AqZA48eNseXV4yXA3AtWxvP9SDkW6eMmzuhypfkdQqaVPZARZAZCTBs47tpJ7Ep2nsC4ff4JJl1InrjRlms8OLaHvVEU0lESUqkKZAhDM3NBUowlRZAKrvCNhatIZCLSHhIa1BbZCG0HPKM3daww2
                      isVerifiedBySocialNetwork:
                        type:
                        - integer
                        - 'null'
                        enum:
                        - 0
                        - 1
                        - null
                        description: is Verified By Social Network
                        example: 1
                      IsBusiness:
                        type:
                        - integer
                        - 'null'
                        enum:
                        - 0
                        - 1
                        - null
                        description: Is account business
                        example: 1
                      TokenInvalidDate:
                        type:
                        - string
                        - 'null'
                        description: Date-time when token invalid
                        example: '2014-02-13T03:40:11'
                      IGFBId:
                        type:
                        - string
                        - 'null'
                        description: IG FB id
                        example: '17841401408454960'
                      Stories:
                        type:
                        - string
                        - 'null'
                        description: Stories
                        default: null
                      StoriesViewCount:
                        type:
                        - integer
                        - 'null'
                        description: Stories view count
                        example: 123
                      NewSocialAccountID:
                        type: number
                        description: New social account id
                        example: -733557
                      PeakStreamConcurrentViews:
                        type:
                        - integer
                        - 'null'
                        description: Stream views count
                        example: 123
                      AvgStreamConcurrentViews:
                        type:
                        - number
                        - 'null'
                        description: Stream views count
                        example: 123.4
                      Subscribers:
                        type: integer
                        description: Count of subscribers for this social
                        example: 1310000
                      VideoDuration:
                        type:
                        - integer
                        - 'null'
                        description: Video duration
                        example: 213412
                      EstimatedUniqueStreamViews:
                        type:
                        - integer
                        - 'null'
                        description: Estimated Unique Stream Views
                        example: 123
                      ViewsVideoCount:
                        type:
                        - integer
                        - 'null'
                        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
                  

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/creatoriq/refs/heads/main/openapi/creatoriq-cj-api-openapi.yml