docs.jsonld
type: ApiDocumentation
title: Narrator Crawler
entrypoint: /api
supported class: Account
supported class: AccountHashtag
supported class: AccountHistory
supported class: AccountMention
supported class: Audience
supported class: Brand
supported class: Hashtag
supported class: Interest
supported class: Mention
supported class: Post
supported class: PostHistory
supported class: TikTokAccount
supported class: TikTokPost
supported class: YoutubeAccount
supported class: YoutubePost
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

Account
type: Class
title: Account
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbFollowers
  title: nbFollowers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbFollowing
  title: nbFollowing
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbPosts
  title: nbPosts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userName
  title: userName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: profileImage
  title: profileImage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageLikes
  title: averageLikes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageComments
  title: averageComments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageViews
  title: averageViews
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: engagementRate
  title: engagementRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: gender
  title: gender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isBusiness
  title: isBusiness
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: city
  title: city
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: instagramId
  title: instagramId
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: brands
  title: brands
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: interests
  title: interests
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: age
  title: age
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: crawledInSuccessAt
  title: crawledInSuccessAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: influencerId
  title: influencerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: photoCost
  title: photoCost
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: videoCost
  title: videoCost
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: storyCost
  title: storyCost
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Account resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Account resource.
  returns: Account
supported operation: Deletes the Account resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Account resource.
  returns: Nothing
supported operation: Replaces the Account resource.
  type: Operation
  type: ReplaceAction
  expects: Account
  method: PUT
  title: Replaces the Account resource.
  returns: Account

createdAt
type: Property
domain: Account
range: dateTime

updatedAt
type: Property
domain: Account
range: dateTime

type
type: Property
domain: Account
range: string

nbFollowers
type: Property
domain: Account
range: integer

nbFollowing
type: Property
domain: Account
range: integer

nbPosts
type: Property
domain: Account
range: integer

userName
type: Property
domain: Account
range: string

fullName
type: Property
domain: Account
range: string

profileImage
type: Property
domain: Account
range: string

averageLikes
type: Property
domain: Account
range: decimal

averageComments
type: Property
domain: Account
range: decimal

averageViews
type: Property
domain: Account
range: decimal

engagementRate
type: Property
domain: Account
range: decimal

gender
type: Property
domain: Account
range: string

isBusiness
type: Property
domain: Account
range: boolean

email
type: Property
domain: Account
range: string

country
type: Property
domain: Account
range: string

state
type: Property
domain: Account
range: string

city
type: Property
domain: Account
range: string

instagramId
type: Property
domain: Account
range: string

language
type: Property
domain: Account
range: string

brands
type: Property
domain: Account
range: Brand

interests
type: Property
domain: Account
range: Interest

age
type: Property
domain: Account
range: string

crawledInSuccessAt
type: Property
domain: Account
range: dateTime

influencerId
type: Property
domain: Account
range: string

photoCost
type: Property
domain: Account
range: decimal

videoCost
type: Property
domain: Account
range: decimal

storyCost
type: Property
domain: Account
range: decimal

phone
type: Property
domain: Account
range: string

AccountHashtag
type: Class
title: AccountHashtag
supported property: SupportedProperty
  property: account
  title: account
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hashtag
  title: hashtag
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cpt
  title: cpt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a AccountHashtag resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AccountHashtag resource.
  returns: AccountHashtag

account
type: Property
domain: AccountHashtag
max cardinality: 1
range: Account

hashtag
type: Property
domain: AccountHashtag
max cardinality: 1
range: Hashtag

cpt
type: Property
domain: AccountHashtag
range: integer

AccountHistory
type: Class
title: AccountHistory
supported operation: Retrieves a AccountHistory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AccountHistory resource.
  returns: AccountHistory

AccountMention
type: Class
title: AccountMention
supported property: SupportedProperty
  property: account
  title: account
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mention
  title: mention
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cpt
  title: cpt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a AccountMention resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AccountMention resource.
  returns: AccountMention

account
type: Property
domain: AccountMention
max cardinality: 1
range: Account

mention
type: Property
domain: AccountMention
max cardinality: 1
range: Mention

cpt
type: Property
domain: AccountMention
range: integer

Audience
type: Class
title: Audience
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbFollowers
  title: nbFollowers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbPosts
  title: nbPosts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbEngagements
  title: nbEngagements
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: engagementRate
  title: engagementRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageLikes
  title: averageLikes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageComments
  title: averageComments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageViews
  title: averageViews
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: audienceCredibility
  title: audienceCredibility
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: account
  title: account
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: majorGender
  title: majorGender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: genderRatio
  title: genderRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: majorAge
  title: majorAge
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ageRatio
  title: ageRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: majorEthnicity
  title: majorEthnicity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ethnicityRatio
  title: ethnicityRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: majorLanguage
  title: majorLanguage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: languageRatio
  title: languageRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: majorCountry
  title: majorCountry
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countriesRatio
  title: countriesRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: majorState
  title: majorState
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statesRatio
  title: statesRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: majorCity
  title: majorCity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: citiesRatio
  title: citiesRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstInterest
  title: firstInterest
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: secondInterest
  title: secondInterest
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: thirdInterest
  title: thirdInterest
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: interestsRatio
  title: interestsRatio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: femaleGenderRatio
  title: femaleGenderRatio
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Audience resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Audience resource.
  returns: Audience

createdAt
type: Property
domain: Audience
range: dateTime

updatedAt
type: Property
domain: Audience
range: dateTime

nbFollowers
type: Property
domain: Audience
range: integer

nbPosts
type: Property
domain: Audience
range: integer

nbEngagements
type: Property
domain: Audience
range: integer

engagementRate
type: Property
domain: Audience
range: decimal

averageLikes
type: Property
domain: Audience
range: decimal

averageComments
type: Property
domain: Audience
range: decimal

averageViews
type: Property
domain: Audience
range: decimal

audienceCredibility
type: Property
domain: Audience
range: decimal

account
type: Link
domain: Audience
max cardinality: 1
range: Account

majorGender
type: Property
domain: Audience
range: string

genderRatio
type: Property
domain: Audience

majorAge
type: Property
domain: Audience
range: string

ageRatio
type: Property
domain: Audience

majorEthnicity
type: Property
domain: Audience
range: string

ethnicityRatio
type: Property
domain: Audience

majorLanguage
type: Property
domain: Audience
range: string

languageRatio
type: Property
domain: Audience

majorCountry
type: Property
domain: Audience
range: string

countriesRatio
type: Property
domain: Audience

majorState
type: Property
domain: Audience
range: string

statesRatio
type: Property
domain: Audience

majorCity
type: Property
domain: Audience
range: string

citiesRatio
type: Property
domain: Audience

firstInterest
type: Property
domain: Audience
range: string

secondInterest
type: Property
domain: Audience
range: string

thirdInterest
type: Property
domain: Audience
range: string

interestsRatio
type: Property
domain: Audience

femaleGenderRatio
type: Property
domain: Audience
range: decimal

Brand
type: Class
title: Brand
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Brand resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Brand resource.
  returns: Brand

name
type: Property
domain: Brand
range: string

Hashtag
type: Class
title: Hashtag
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cpt
  title: cpt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Hashtag resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Hashtag resource.
  returns: Hashtag

name
type: Property
domain: Hashtag
range: string

cpt
type: Property
domain: Hashtag
range: integer

Interest
type: Class
title: Interest
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Interest resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Interest resource.
  returns: Interest

name
type: Property
domain: Interest
range: string

Mention
type: Class
title: Mention
supported property: SupportedProperty
  property: userName
  title: userName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: socialId
  title: socialId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activity
  title: activity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbFollowers
  title: nbFollowers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbFollowing
  title: nbFollowing
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbPosts
  title: nbPosts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: picture
  title: picture
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cpt
  title: cpt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bio
  title: bio
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: usedAt
  title: usedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isBusiness
  title: isBusiness
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Mention resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Mention resource.
  returns: Mention

userName
type: Property
domain: Mention
range: string

socialId
type: Property
domain: Mention
range: string

fullName
type: Property
domain: Mention
range: string

activity
type: Property
domain: Mention
range: string

nbFollowers
type: Property
domain: Mention
range: integer

nbFollowing
type: Property
domain: Mention
range: integer

nbPosts
type: Property
domain: Mention
range: integer

picture
type: Property
domain: Mention
range: string

cpt
type: Property
domain: Mention
range: integer

bio
type: Property
domain: Mention
range: string

usedAt
type: Property
domain: Mention
range: dateTime

isBusiness
type: Property
domain: Mention
range: boolean

Post
type: Class
title: Post
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: imageLowResolutionUrl
  title: imageLowResolutionUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: imageThumbnailUrl
  title: imageThumbnailUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: imageStandardResolutionUrl
  title: imageStandardResolutionUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: imageHighResolutionUrl
  title: imageHighResolutionUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: caption
  title: caption
  required: false
  readable: true
  writeable: true
  description: Max caption length : 2200 char (seems to need a bit more for unicode chars)
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbLikes
  title: nbLikes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbViews
  title: nbViews
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbComments
  title: nbComments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: engagements
  title: engagements
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: videoLowResolutionUrl
  title: videoLowResolutionUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: videoStandardResolutionUrl
  title: videoStandardResolutionUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: medias
  title: medias
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: mentions
  title: mentions
  required: false
  readable: true
  writeable: false
  description: Used to save processed mentions.
supported property: SupportedProperty
  property: hashtags
  title: hashtags
  required: false
  readable: true
  writeable: false
  description: Used to save processed hashtags.
supported property: SupportedProperty
  property: isStory
  title: isStory
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbImpressions
  title: nbImpressions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reach
  title: reach
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tapsForward
  title: tapsForward
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tapsBack
  title: tapsBack
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: exits
  title: exits
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: replies
  title: replies
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: origin
  title: origin
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Post resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Post resource.
  returns: Post
supported operation: Replaces the Post resource.
  type: Operation
  type: ReplaceAction
  expects: Post
  method: PUT
  title: Replaces the Post resource.
  returns: Post
supported operation: Deletes the Post resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Post resource.
  returns: Nothing

id
type: Property
domain: Post
range: string

createdAt
type: Property
domain: Post
range: dateTime

updatedAt
type: Property
domain: Post
range: dateTime

type
type: Property
domain: Post
range: string

url
type: Property
domain: Post
range: string

imageLowResolutionUrl
type: Property
domain: Post
range: string

imageThumbnailUrl
type: Property
domain: Post
range: string

imageStandardResolutionUrl
type: Property
domain: Post
range: string

imageHighResolutionUrl
type: Property
domain: Post
range: string

caption
type: Property
domain: Post
range: string

owner
type: Property
domain: Post
max cardinality: 1
range: Account

nbLikes
type: Property
domain: Post
range: integer

nbViews
type: Property
domain: Post
range: integer

nbComments
type: Property
domain: Post
range: integer

engagements
type: Property
domain: Post
range: integer

videoLowResolutionUrl
type: Property
domain: Post
range: string

videoStandardResolutionUrl
type: Property
domain: Post
range: string

medias
type: Property
domain: Post

mentions
type: Property
domain: Post
range: string

hashtags
type: Property
domain: Post
range: string

isStory
type: Property
domain: Post
range: boolean

nbImpressions
type: Property
domain: Post
range: integer

reach
type: Property
domain: Post
range: integer

tapsForward
type: Property
domain: Post
range: integer

tapsBack
type: Property
domain: Post
range: integer

exits
type: Property
domain: Post
range: integer

replies
type: Property
domain: Post
range: integer

origin
type: Property
domain: Post
range: string

PostHistory
type: Class
title: PostHistory
supported operation: Retrieves a PostHistory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PostHistory resource.
  returns: PostHistory

TikTokAccount
type: Class
title: TikTokAccount
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: tiktokId
  title: tiktokId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: username
  title: username
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbFollowers
  title: nbFollowers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbPosts
  title: nbPosts
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbLikes
  title: nbLikes
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbComments
  title: nbComments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbViews
  title: nbViews
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageLikes
  title: averageLikes
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageComments
  title: averageComments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageViews
  title: averageViews
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageEngagement
  title: averageEngagement
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: engagementRate
  title: engagementRate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbShares
  title: nbShares
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageShare
  title: averageShare
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: crawledInSuccessAt
  title: crawledInSuccessAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: crawledInErrorAt
  title: crawledInErrorAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: gender
  title: gender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: age
  title: age
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: profilePictureUrl
  title: profilePictureUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: influencerId
  title: influencerId
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TikTokAccount resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TikTokAccount resource.
  returns: TikTokAccount
supported operation: Deletes the TikTokAccount resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TikTokAccount resource.
  returns: Nothing
supported operation: Replaces the TikTokAccount resource.
  type: Operation
  type: ReplaceAction
  expects: TikTokAccount
  method: PUT
  title: Replaces the TikTokAccount resource.
  returns: TikTokAccount

createdAt
type: Property
domain: TikTokAccount
range: dateTime

updatedAt
type: Property
domain: TikTokAccount
range: dateTime

tiktokId
type: Property
domain: TikTokAccount
range: string

username
type: Property
domain: TikTokAccount
range: string

country
type: Property
domain: TikTokAccount
range: string

nbFollowers
type: Property
domain: TikTokAccount
range: integer

nbPosts
type: Property
domain: TikTokAccount
range: integer

nbLikes
type: Property
domain: TikTokAccount
range: integer

nbComments
type: Property
domain: TikTokAccount
range: integer

nbViews
type: Property
domain: TikTokAccount
range: integer

averageLikes
type: Property
domain: TikTokAccount
range: decimal

averageComments
type: Property
domain: TikTokAccount
range: decimal

averageViews
type: Property
domain: TikTokAccount
range: decimal

averageEngagement
type: Property
domain: TikTokAccount
range: decimal

engagementRate
type: Property
domain: TikTokAccount
range: decimal

nbShares
type: Property
domain: TikTokAccount
range: integer

averageShare
type: Property
domain: TikTokAccount
range: decimal

crawledInSuccessAt
type: Property
domain: TikTokAccount
range: dateTime

crawledInErrorAt
type: Property
domain: TikTokAccount
range: dateTime

gender
type: Property
domain: TikTokAccount
range: string

language
type: Property
domain: TikTokAccount
range: string

age
type: Property
domain: TikTokAccount
range: string

email
type: Property
domain: TikTokAccount
range: string

phone
type: Property
domain: TikTokAccount
range: string

fullName
type: Property
domain: TikTokAccount
range: string

profilePictureUrl
type: Property
domain: TikTokAccount
range: string

influencerId
type: Property
domain: TikTokAccount
range: string

TikTokPost
type: Class
title: TikTokPost
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tiktokId
  title: tiktokId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: caption
  title: caption
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coverUrl
  title: coverUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: videoUrl
  title: videoUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbLikes
  title: nbLikes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbViews
  title: nbViews
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbComments
  title: nbComments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbShares
  title: nbShares
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: requiredHashTags
  title: requiredHashTags
  required: false
  readable: false
  writeable: false
  description: Check if the posts has the minimum number of required hashtags.
supported operation: Retrieves a TikTokPost resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TikTokPost resource.
  returns: TikTokPost

createdAt
type: Property
domain: TikTokPost
range: dateTime

updatedAt
type: Property
domain: TikTokPost
range: dateTime

tiktokId
type: Property
domain: TikTokPost
range: string

caption
type: Property
domain: TikTokPost
range: string

owner
type: Link
domain: TikTokPost
max cardinality: 1
range: TikTokAccount

coverUrl
type: Property
domain: TikTokPost
range: string

videoUrl
type: Property
domain: TikTokPost
range: string

nbLikes
type: Property
domain: TikTokPost
range: integer

nbViews
type: Property
domain: TikTokPost
range: integer

nbComments
type: Property
domain: TikTokPost
range: integer

nbShares
type: Property
domain: TikTokPost
range: integer

url
type: Property
domain: TikTokPost
range: string

requiredHashTags
type: Property
domain: TikTokPost
range: boolean

YoutubeAccount
type: Class
title: YoutubeAccount
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: youtubeId
  title: youtubeId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: username
  title: username
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbFollowers
  title: nbFollowers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbPosts
  title: nbPosts
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbLikes
  title: nbLikes
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbComments
  title: nbComments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbViews
  title: nbViews
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageLikes
  title: averageLikes
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageComments
  title: averageComments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageViews
  title: averageViews
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageEngagement
  title: averageEngagement
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: engagementRate
  title: engagementRate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: nbShares
  title: nbShares
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: averageShare
  title: averageShare
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: crawledInSuccessAt
  title: crawledInSuccessAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: crawledInErrorAt
  title: crawledInErrorAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: profileImage
  title: profileImage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: gender
  title: gender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: age
  title: age
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: influencerId
  title: influencerId
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a YoutubeAccount resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a YoutubeAccount resource.
  returns: YoutubeAccount
supported operation: Deletes the YoutubeAccount resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the YoutubeAccount resource.
  returns: Nothing
supported operation: Replaces the YoutubeAccount resource.
  type: Operation
  type: ReplaceAction
  expects: YoutubeAccount
  method: PUT
  title: Replaces the YoutubeAccount resource.
  returns: YoutubeAccount

createdAt
type: Property
domain: YoutubeAccount
range: dateTime

updatedAt
type: Property
domain: YoutubeAccount
range: dateTime

youtubeId
type: Property
domain: YoutubeAccount
range: string

username
type: Property
domain: YoutubeAccount
range: string

country
type: Property
domain: YoutubeAccount
range: string

nbFollowers
type: Property
domain: YoutubeAccount
range: integer

nbPosts
type: Property
domain: YoutubeAccount
range: integer

nbLikes
type: Property
domain: YoutubeAccount
range: integer

nbComments
type: Property
domain: YoutubeAccount
range: integer

nbViews
type: Property
domain: YoutubeAccount
range: integer

averageLikes
type: Property
domain: YoutubeAccount
range: decimal

averageComments
type: Property
domain: YoutubeAccount
range: decimal

averageViews
type: Property
domain: YoutubeAccount
range: decimal

averageEngagement
type: Property
domain: YoutubeAccount
range: decimal

engagementRate
type: Property
domain: YoutubeAccount
range: decimal

nbShares
type: Property
domain: YoutubeAccount
range: integer

averageShare
type: Property
domain: YoutubeAccount
range: decimal

crawledInSuccessAt
type: Property
domain: YoutubeAccount
range: dateTime

crawledInErrorAt
type: Property
domain: YoutubeAccount
range: dateTime

profileImage
type: Property
domain: YoutubeAccount
range: string

gender
type: Property
domain: YoutubeAccount
range: string

language
type: Property
domain: YoutubeAccount
range: string

age
type: Property
domain: YoutubeAccount
range: string

email
type: Property
domain: YoutubeAccount
range: string

phone
type: Property
domain: YoutubeAccount
range: string

fullName
type: Property
domain: YoutubeAccount
range: string

influencerId
type: Property
domain: YoutubeAccount
range: string

YoutubePost
type: Class
title: YoutubePost
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: youtubeId
  title: youtubeId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: caption
  title: caption
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coverUrl
  title: coverUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: videoUrl
  title: videoUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbLikes
  title: nbLikes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbViews
  title: nbViews
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nbComments
  title: nbComments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lengthSeconds
  title: lengthSeconds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: keywords
  title: keywords
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isShort
  title: isShort
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: requiredHashTags
  title: requiredHashTags
  required: false
  readable: false
  writeable: false
  description: Check if the posts has the minimum number of required hashtags.
supported property: SupportedProperty
  property: urlShort
  title: urlShort
  required: false
  readable: false
  writeable: false
  description: Tells if a post URL is a Youtube short.
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a YoutubePost resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a YoutubePost resource.
  returns: YoutubePost

createdAt
type: Property
domain: YoutubePost
range: dateTime

updatedAt
type: Property
domain: YoutubePost
range: dateTime

youtubeId
type: Property
domain: YoutubePost
range: string

caption
type: Property
domain: YoutubePost
range: string

owner
type: Link
domain: YoutubePost
max cardinality: 1
range: YoutubeAccount

coverUrl
type: Property
domain: YoutubePost
range: string

videoUrl
type: Property
domain: YoutubePost
range: string

nbLikes
type: Property
domain: YoutubePost
range: integer

nbViews
type: Property
domain: YoutubePost
range: integer

nbComments
type: Property
domain: YoutubePost
range: integer

lengthSeconds
type: Property
domain: YoutubePost
range: integer

keywords
type: Property
domain: YoutubePost

title
type: Property
domain: YoutubePost
range: string

isShort
type: Property
domain: YoutubePost
range: boolean

requiredHashTags
type: Property
domain: YoutubePost
range: boolean

urlShort
type: Property
domain: YoutubePost
range: boolean

url
type: Property
domain: YoutubePost
range: string

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Account resources
  title: The collection of Account resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of AccountHashtag resources
  title: The collection of AccountHashtag resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of AccountMention resources
  title: The collection of AccountMention resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Audience resources
  title: The collection of Audience resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Brand resources
  title: The collection of Brand resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Hashtag resources
  title: The collection of Hashtag resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Interest resources
  title: The collection of Interest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Mention resources
  title: The collection of Mention resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Post resources
  title: The collection of Post resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TikTokAccount resources
  title: The collection of TikTokAccount resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TikTokPost resources
  title: The collection of TikTokPost resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of YoutubeAccount resources
  title: The collection of YoutubeAccount resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of YoutubePost resources
  title: The collection of YoutubePost resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of Account resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Account
supported operation: Retrieves the collection of Account resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Account resources.
  returns: Collection
supported operation: Creates a Account resource.
  type: Operation
  type: CreateAction
  expects: Account
  method: POST
  title: Creates a Account resource.
  returns: Account
supported operation: Retrieves the collection of Account resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Account resources.
  returns: Collection

The collection of AccountHashtag resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AccountHashtag
supported operation: Retrieves the collection of AccountHashtag resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of AccountHashtag resources.
  returns: Collection

The collection of AccountMention resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AccountMention
supported operation: Retrieves the collection of AccountMention resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of AccountMention resources.
  returns: Collection

The collection of Audience resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Audience
supported operation: Retrieves the collection of Audience resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Audience resources.
  returns: Collection

The collection of Brand resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Brand
supported operation: Retrieves the collection of Brand resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Brand resources.
  returns: Collection

The collection of Hashtag resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Hashtag
supported operation: Retrieves the collection of Hashtag resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Hashtag resources.
  returns: Collection

The collection of Interest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Interest
supported operation: Retrieves the collection of Interest resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Interest resources.
  returns: Collection

The collection of Mention resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Mention
supported operation: Retrieves the collection of Mention resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Mention resources.
  returns: Collection

The collection of Post resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Post
supported operation: Retrieves the collection of Post resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Post resources.
  returns: Collection
supported operation: Creates a Post resource.
  type: Operation
  type: CreateAction
  expects: Post
  method: POST
  title: Creates a Post resource.
  returns: Post

The collection of TikTokAccount resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TikTokAccount
supported operation: Retrieves the collection of TikTokAccount resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TikTokAccount resources.
  returns: Collection
supported operation: Creates a TikTokAccount resource.
  type: Operation
  type: CreateAction
  expects: TikTokAccount
  method: POST
  title: Creates a TikTokAccount resource.
  returns: TikTokAccount

The collection of TikTokPost resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TikTokPost
supported operation: Retrieves the collection of TikTokPost resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TikTokPost resources.
  returns: Collection

The collection of YoutubeAccount resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: YoutubeAccount
supported operation: Retrieves the collection of YoutubeAccount resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of YoutubeAccount resources.
  returns: Collection
supported operation: Creates a YoutubeAccount resource.
  type: Operation
  type: CreateAction
  expects: YoutubeAccount
  method: POST
  title: Creates a YoutubeAccount resource.
  returns: YoutubeAccount

The collection of YoutubePost resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: YoutubePost
supported operation: Retrieves the collection of YoutubePost resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of YoutubePost resources.
  returns: Collection

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation