SCALAR
ID
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
link GraphQL Schema definition
- scalar ID
link Require by
- A2VConversionFailedA Notification with type: a2v_conversion_failed
- AcceptAgreementInputAutogenerated input type of AcceptAgreement
- AcceptPayeeAssetSplitInputAutogenerated input type of AcceptPayeeAssetSplit
- AdBannerAsset Revenue of a user
- AdditionalServiceAn additional service is an add on for any release
- AdditionalServiceBundleAdditional Services bundled together for cost savings
- AdditionalServiceBundlesCursorInputCursor input object for AdditionalServiceBundlesCursor
- AdditionalServiceObjectAdditional Service
- AdditionalServicesCursorInputCursor input object for AdditionalServicesCursor
- AdminAddedComposerA Notification with type: admin_added_composer
- AdminAssertedRightsA Notification with type: admin_asserted_rights
- AdminCreatedPoliciesA Notification with type: admin_created_policies
- AdminPayeeAssetSplitAcceptedA Notification with type : admin_payee_asset_split_accepted
- AdminPayeeAssetSplitRejectedA Notification with type : admin_payee_asset_split_rejected
- AdminPayeeAssetSplitTerminatedA Notification with type: admin_payee_asset_split_terminated
- AdminUpdatedComposerA Notification with type: admin_updated_composer
- AdminUpdatedOwnershipA Notification with type: admin_updated_ownership
- AdminUpdatedPoliciesA Notification with type: admin_updated_policies
- AgreementAn agreement template which can be signed by a User. There are several categories. Once an agreement is signed, a SignedAgreement is created.
- AlbumCollection of medias to be sent out under an album to partner networks
- AlbumMediaA media on an album with track number
- AlbumMetadataThe metadata on an album
- AlbumPartnerDataThe album's data on partner's end
- AnalyticsChartThe data points and total value for a chart
- AnalyticsCountryAnalytics country object
- AnalyticsMetricAnalytics Network
- AnalyticsPlaylistAn AnalyticsPlaylist
- AnalyticsTopArtistA top artist with its analytics
- AnalyticsTopArtistsCursorInputCursor input object for AnalyticsTopArtistsCursor
- AnalyticsTopContentA top media with its analytics
- AnalyticsTopContentCursorInputCursor input object for AnalyticsTopContentCursor
- AnalyticsTopGeocountryA top media with its analytics
- AnalyticsTopGeocountryCursorInputCursor input object for AnalyticsTopGeocountryCursor
- AnalyticsTopUserA top user with its analytics
- AppleMusicArtistAnalyticsApple Music Artist Analytics
- AppleMusicPlaylistInformation about an Apple Music playlist
- AppleMusicTrackAnalyticsThe analytics for an apple music track
- ArchivePayeeAssetSplitsInputAutogenerated input type of ArchivePayeeAssetSplits
- ArchivePayeeInviteInputAutogenerated input type of ArchivePayeeInvite
- ArtistAn artist profile
- ArtistsCursorInputCursor input object for ArtistsCursor
- ArtistUpdatedA Notification with type: artist_updated
- AssetA royalty asset is a music video, sound recording, composition, or web asset that can collect revenue
- AssetRevenueAsset Revenue of a user
- AssetRevenuesCursorInputCursor input object for AssetRevenuesCursor
- AudioAnalyticsAudio Analytics
- AudioAnalyticsByAgegroupAudio Analytics By Age Group
- AudioAnalyticsByAgegroupCursorInputCursor input object for AudioAnalyticsByAgegroupCursor
- AudioAnalyticsByCountryAudio Analytics By Country
- AudioAnalyticsByCountryCursorInputCursor input object for AudioAnalyticsByCountryCursor
- AudioAnalyticsByDeviceAudio Analytics By Device
- AudioAnalyticsByDeviceCursorInputCursor input object for AudioAnalyticsByDeviceCursor
- AudioAnalyticsByGenderAudio Analytics By Gender
- AudioAnalyticsByGenderCursorInputCursor input object for AudioAnalyticsByGenderCursor
- AudioAnalyticsBySourceAudio Analytics By Source
- AudioAnalyticsBySourceCursorInputCursor input object for AudioAnalyticsBySourceCursor
- AudioAnalyticsCursorInputCursor input object for AudioAnalyticsCursor
- AudiomackUserAn Audiomack User
- AuthErrorA Notification with type: auth_error
- BalanceAdjustmentRepresents a transactional update to the balance of an earnings client
- BalanceHistoryDateSummariesCursorInputCursor input object for BalanceHistoryDateSummariesCursor
- BalanceHistoryDateSummarySummary of all balance adjustments that occurred for a user on a specific date.
- BrandingA Branding object contains all of a whitelabel organization's brand information and asset urls
- BroadcastWhen content (Media or Album) is released (Release), the destinations (Networks) are indicated by the Release's list of Broadcasts. The Broadcast object contains details and status information that can be used to determine a piece of content's live-status on a Network. Note that one piece of content can have multiple releases, and in some cases one piece of content may have multiple Broadcasts for the same Network on different Releases; however, a single release should never have multiple Broadcasts for the same Network.
- BroadcastsCursorInputCursor input object for BroadcastsCursor
- CancelSyncInputAutogenerated input type of CancelSync
- CarouselItemA custom title and body to appear on an organizations sign in features
- CashAdvanceRecoupmentA label client advance recoupment
- CashAdvanceRecoupmentCreatedA Notification with type: cash_advance_recoupment_created
- CollaboratingArtistA collaborating artist to a metadata or album
- CompContentObjectComposition Content Object
- ComposerA Composer
- ConnectFbAndIgToArtistInputAutogenerated input type of ConnectFbAndIgToArtist
- CountryCountry object
- CreateAlbumInputAutogenerated input type of CreateAlbum
- CreateAlbumReleaseInputAutogenerated input type of CreateAlbumRelease
- CreateArtistInputAutogenerated input type of CreateArtist
- CreateAssetsInputAutogenerated input type of CreateAssets
- CreateCashAdvanceRecoupmentInputAutogenerated input type of CreateCashAdvanceRecoupment
- CreateComposerInputAutogenerated input type of CreateComposer
- CreateJwtInputAutogenerated input type of CreateJwt
- CreateMediaInputAutogenerated input type of CreateMedia
- CreateMessageInputAutogenerated input type of CreateMessage
- CreateReleaseInputAutogenerated input type of CreateRelease
- DailyAudioAnalyticsDaily Audio Analytics
- DailymotionAuthErrorA Notification with type: dailymotion_auth_error
- DailymotionUserA dailymotion user
- DeleteAlbumsInputAutogenerated input type of DeleteAlbums
- DeleteArtistInputAutogenerated input type of DeleteArtist
- DeleteMediaInputAutogenerated input type of DeleteMedia
- DeleteMediasInputAutogenerated input type of DeleteMedias
- DeploymentConfirmedA Notification with type: deployment_confirmed
- DeploymentScheduledA Notification with type: deployment_scheduled
- DisconnectDailymotionUserFromArtistInputAutogenerated input type of DisconnectDailymotionUserFromArtist
- DisconnectFacebookPageFromArtistInputAutogenerated input type of DisconnectFacebookPageFromArtist
- DisconnectInstagramBusinessAccountFromArtistInputAutogenerated input type of DisconnectInstagramBusinessAccountFromArtist
- DisconnectSocialAccountFromArtistInputAutogenerated input type of DisconnectSocialAccountFromArtist
- DisconnectTwitterUserFromArtistInputAutogenerated input type of DisconnectTwitterUserFromArtist
- DisconnectYoutubeChannelFromArtistInputAutogenerated input type of DisconnectYoutubeChannelFromArtist
- DowngradeBroadcastsInputAutogenerated input type of DowngradeBroadcasts
- DowngradeStorageTierInputAutogenerated input type of DowngradeStorageTier
- EditComposerObjectComposer Object
- EditOrganizationUserInputAutogenerated input type of EditOrganizationUser
- EditRightsObjectRights Object
- ExtraLinkExtra link object for album to show on smartlinks page
- ExtraLinkObjectExtra Link Object
- FacebookArtistAnalyticsFacebook Artist Analytics
- FacebookAuthErrorA Notification with type: facebook_auth_error
- FacebookPageA facebook page
- FacebookTopVideoA Facebook video returned from the top videos api call
- FacebookVideoAnalyticsThe analytics for an facebook video
- FbPageFb Page
- FileObjectFile Object
- FileUploadFile uploaded for a Media, Album, Message, or another resource
- GenerateAlbumSlugInputAutogenerated input type of GenerateAlbumSlug
- GenericA fallback Notification type for when a developer makes a mistake.
- GeocountryGeocountry object
- GroupedBalanceAdjustmentRepresents balance adjustments grouped by network
- IgAccountIg account
- ImportInstagramVideosInputAutogenerated input type of ImportInstagramVideos
- InsightsAvailableNetworkAn analytics network for a media and its oldest date with data
- InstagramArtistAnalyticsInstagram Artist Analytics
- InstagramArtistAudienceAnalyticsInstagram Artist Audience Analytics
- InstagramBusinessAccountAn Instagram business account
- InstagramBusinessTopVideoAn Instagram video returned from the top videos api call
- InstagramStoryAnalyticsThe analytics for an instagram story
- InstagramUserAn Instagram user
- InstagramVideoAnalyticsThe analytics for an instagram video
- JWTReturnPayloadThe return payload from the JWT helper method
- MarkAsReadInputAutogenerated input type of MarkAsRead
- MediaAn artist's media
- MediaLanguageA designated language for the audio on a media.
- MediaNetworkAnalyticsMedia analytics for a specific network.
- MediaRemainingPayeePercentageThe remaining percentage amount that is yet to be allocated to payees
- MediaSubCategoryOne of the available sub categories for web videos
- MediasV2CursorInputCursor input object for MediasV2Cursor
- MediaUserInformation about a media's earnings for a particular user
- MergeCompletedA Notification with type: merge_completed
- MergeConflictA Notification with type: merge_conflict
- MessageA Message
- MetadataA artist's media's metadata used in rendering template for partner
- MonthHasDataInformation about whether or not a month has any data
- MonthlyNetworkRevenueNetwork Revenue of an Top Artist
- MonthlyNetworkRevenuesCursorInputCursor input object for MonthlyNetworkRevenuesCursor
- NetworkOne of a user's Release's broadcast's networks
- NetworkExtraAdditional Services for Networks
- NetworkGroupParent network group for networks
- NetworkRevenueNetwork Revenue of an Top Artist
- NetworkRevenuesCursorInputCursor input object for NetworkRevenuesCursor
- NewAdminMessageA Notification with type: new_admin_message
- NewComposerObjectComposer Object
- NewConflictA Notification with type: new_conflict
- NewFacebookImportA Notification with type: new_facebook_import
- NewInstagramImportA Notification with type: new_instagram_import
- NewMergeRequestA Notification with type: new_merge_request
- NewMessageA Notification with type: new_message
- NewYoutubeImportA Notification with type: new_youtube_import
- NotificationA user Notification
- NotifyUploadCompletePayloadAutogenerated return type of NotifyUploadComplete
- ObserveUserInputAutogenerated input type of ObserveUser
- OrganizationAn organization
- OrganizationInviteAcceptedA Notification with type: organization_invite_accepted
- OrganizationReleaseCreatedA Notification with type: organization_release_created
- PayeeAssetObjectnull
- PayeeAssetSplitA payor shared an asset with a payee
- PayeeAssetSplitAcceptedA Notification with type: payee_asset_split_accepted
- PayeeAssetSplitExistingUserInviteA Notification with type: payee_asset_split_existing_user_invite
- PayeeAssetSplitExpiredForPayeeA Notification with type: payee_asset_split_expired_for_payee
- PayeeAssetSplitExpiredForPayorA Notification with type: payee_asset_split_expired_for_payor
- PayeeAssetSplitRejectedA Notification with type: payee_asset_split_rejected
- PayeeAssetSplitTerminatedA Notification with type: payee_asset_split_terminated
- PayeeInviteAn invite from a payor to a payee
- PayeeInvitesV2CursorInputCursor input object for PayeeInvitesV2Cursor
- PayeeMediaSplitA media and its associated payee asset fields for a payee invitation
- PaymentAddressInformation about a payment address
- PaymentMethodInformation about a payment method
- PaymentMethodCreditCardInformation about a payment method of credit card type
- PaymentMethodPaypalAccountInformation about a payment method of paypal account type
- PayorA payor user
- PerformanceRightsOrganizationA performance rights organization object
- PolicyA metadata's policies
- PresignedUrlA presigned url object for s3 uploads
- ProcessingFinishedA Notification with type: processing_finished
- ProvinceA geographic state or province belonging to a territory as part of an address. This is a map of two letter province code to its name
- PublisherA composer's publisher
- QuarterlyEarningsA top media with its earnings information
- QuarterlyEarningsCursorInputCursor input object for QuarterlyEarningsCursor
- QueryThe query root of this schema
- RankedMediaA top media with its earnings information
- ReadNotificationInputAutogenerated input type of ReadNotification
- RejectPayeeAssetSplitInputAutogenerated input type of RejectPayeeAssetSplit
- ReleaseA one of a user's Releases
- ReleaseCalendarItemA Release Calendar Item
- ReleaseConfirmationInputAutogenerated input type of ReleaseConfirmation
- ReleasesV2CursorInputCursor input object for ReleasesV2Cursor
- RequestVevoChannelInputAutogenerated input type of RequestVevoChannel
- ResendPayeeInviteInputAutogenerated input type of ResendPayeeInvite
- ResendWelcomeInvitationInputAutogenerated input type of ResendWelcomeInvitation
- RevenueByMonthA representation of earnings during one month
- RevenueMonthGroupA representation of earnings during one month for one specific period group/network
- RightAn artist's media metadata's right
- RoyaltyCenterTipaltiAddedA Notification with type: royalty_center_tipalti_added
- SalesTrendA sales trend for a user or organization
- SalesTrendsByCountryUser Sales Trends By Country Code
- SalesTrendsByDateSales Trends By Date
- SalesTrendsByNetworkSales Trends By Network
- SalesTrendsInputCursor input object for SalesTrends
- SalesTrendsTotalsSales Trends Totals
- SendBalanceHistoryDetailsReportInputAutogenerated input type of SendBalanceHistoryDetailsReport
- SendMediaAnalyticsReportInputAutogenerated input type of SendMediaAnalyticsReport
- SendRoyaltyCenterPaymentHistoryInputAutogenerated input type of SendRoyaltyCenterPaymentHistory
- SendYoutubeConflictsReportInputAutogenerated input type of SendYoutubeConflictsReport
- SessionA Session object contains various data from the Application User's session cookie
- SignedAgreementA signed agreement between Vydia and a User
- SocialA users social
- SocialsSocial Object
- SplitObjectnull
- SplitTestA split test or a/b test experiment which allows a limited set of specific variants
- SpotifyArtistAnalyticsSpotify Artist Analytics
- SpotifyPlaylistInformation about a Spotify playlist
- SpotifyTrackAnalyticsThe analytics for a spotify track
- SpotifyUserA Spotify User
- StatementA single period
- StatementGroupA group of statements
- StatementsCursorInputCursor input object for StatementsCursor
- StatusUpdatedA Notification with type: status_updated
- StorageTierA storage tier
- StorageTierChargeA tier permission's charge
- SubscriptionOne of a user's subscriptions
- SyncConfigSocial Sync Configuration Object is when user opts for social sync. This object contains IDs for each social the user opts syncing for
- TerritoryA geographic territory where media ownership can be claimed. This is a map of Two letter country code to its name
- TestExampleA split specific split test experiment which has been dynamically defined, implements Interfaces::Experiment, and sets its own allowed variants Enum type
- TierPermissionA tier permission. Contains information about the pricing and storage for a `StorageTier`
- TipaltiPayeeDetailsUpdatedA Notification with type: tipalti_payee_details_updated
- TopAlbumTop album of an organization
- TopAlbumMediaA top album media with its earnings information
- TopAlbumMediasCursorInputCursor input object for TopAlbumMediasCursor
- TopAlbumsCursorInputCursor input object for TopAlbumsCursor
- TopArtistTop artist of an organization
- TopArtistsCursorInputCursor input object for TopArtistsCursor
- TopGeocountryTop artist of an organization
- TopGeocountryCursorInputCursor input object for TopGeocountryCursor
- TopMediaA top media with its earnings information
- TopMediasCursorInputCursor input object for TopMediasCursor
- TopUserTop user of an organization
- TopUsersCursorInputCursor input object for TopUsersCursor
- TransactionA user's transaction
- TwitterAuthErrorA Notification with type: twitter_auth_error
- TwitterUserA Twitter User
- UnarchivePayeeInviteInputAutogenerated input type of UnarchivePayeeInvite
- UpdateAlbumArtworkInputAutogenerated input type of UpdateAlbumArtwork
- UpdateAlbumLinksInputAutogenerated input type of UpdateAlbumLinks
- UpdateAlbumMediaIdsInputAutogenerated input type of UpdateAlbumMediaIds
- UpdateAlbumMetadataInputAutogenerated input type of UpdateAlbumMetadata
- UpdateArtistAppleEidInputAutogenerated input type of UpdateArtistAppleEid
- UpdateArtistInputAutogenerated input type of UpdateArtist
- UpdateArtistSpotifyEidInputAutogenerated input type of UpdateArtistSpotifyEid
- UpdateBroadcastStatusInputAutogenerated input type of UpdateBroadcastStatus
- UpdateCategoryInputAutogenerated input type of UpdateCategory
- UpdateComposerInputAutogenerated input type of UpdateComposer
- UpdateMediaArtistInputAutogenerated input type of UpdateMediaArtist
- UpdateMetadataInputAutogenerated input type of UpdateMetadata
- UpdateOwnershipAndPoliciesInputAutogenerated input type of UpdateOwnershipAndPolicies
- UpdateRightsInputAutogenerated input type of UpdateRights
- UpdateSocialSyncInputAutogenerated input type of UpdateSocialSync
- UpdateUserInputAutogenerated input type of UpdateUser
- UpgradeArtistsInputAutogenerated input type of UpgradeArtists
- UploadFailedA Notification with type: upload_failed
- UploadFinishedA Notification with type: upload_finished
- UserA user account. All fields are for an authorized user, except for email
- UserAddedComposerA Notification with type: user_added_composer
- UserAgreementan user agreement to Vydia agreeing to a royalty split, contains information about the expiration
- UserAssertedRightsA Notification with type: user_asserted_rights
- UserCreatedPoliciesA Notification with type: user_created_policies
- UserErrorAll errors of one attribute of a User Form Validation Error
- UserUpdatedComposerA Notification with type: user_updated_composer
- UserUpdatedOwnershipA Notification with type: user_updated_ownership
- UserUpdatedPoliciesA Notification with type: user_updated_policies
- VevoVideoAnalyticsThe analytics for a vevo video
- VevoYoutubeChannelA Vevo Channel
- VevoYoutubeVideoA Vevo Youtube Video
- WhitelabelBannerAdA split specific split test experiment which has been dynamically defined, implements Interfaces::Experiment, and sets its own allowed variants Enum type
- YoutubeArtistAnalyticsYoutube Artist Analytics
- YoutubeAuthErrorA Notification with type: youtube_auth_error
- YoutubeChannelA youtube channel
- YoutubeConflictA Youtube conflict for an Asset
- YoutubeConflictsCursorInputCursor input object for YoutubeConflictsCursor
- YoutubeConflictTotalsTotal aggregates for Youtube conflicts over medias, or artists, users, or by organization
- YoutubeOacPricingA split specific split test experiment which has been dynamically defined, implements Interfaces::Experiment, and sets its own allowed variants Enum type
- YoutubeTopVideoA Youtube video returned from the top videos api call
- YoutubeUgcA Youtube claim for video
- YoutubeUgcClaimsReportInformation about Youtube UGC Claims report, One of the report source for ugc_claims_report_cursor on media
- YoutubeUgcCursorInputCursor input object for YoutubeUgcCursor
- YoutubeUgcTotalsTotal aggregates for Youtube UGC over medias, or artists, users, or by organization
- YoutubeVideoAnalyticsThe analytics for a youtube video