REST Resource: claimHistory

  • claimHistory resources detail the lifecycle of a claim, including events like creation, updates, disputes, and closure.

  • Each claimEvent resource represents a specific occurrence in a claim's history, including details like the event time, type, reason, and source.

  • The Source resource specifies information related to the origin of a claimEvent, including the event source type, user email, and content owner ID.

  • The TypeDetails resource provides specifics about the event's type, such as the dispute reason, update status, dispute notes, or appeal explanations.

  • The get method within the claimHistory allows retrieving the full history for a specified claim.

Resource: ClaimHistory

A claimHistory resource identifies the set of events that describe a claim's life cycle, such as the claim being created, updated, disputed, or closed.

JSON representation 
{
  "kind": string,
  "event": [
    {
      object (ClaimEvent)
    }
  ],
  "id": string,
  "uploaderChannelId": string
}
Fields
kind

string

The type of the API resource. For claimHistory resources, this value is youtubePartner#claimHistory.
event[]

object (ClaimEvent)

A list of claim history events.
id

string

The ID that YouTube assigns and uses to uniquely identify the claim.
uploaderChannelId

string

The external channel id of claimed video's uploader.

ClaimEvent

A claimEvent resource represents a single event in claim's life cycle.

JSON representation 
{
  "time": string,
  "kind": string,
  "type": string,
  "reason": string,
  "source": {
    object (Source)
  },
  "typeDetails": {
    object (TypeDetails)
  }
}
Fields
time

string

The time when the event occurred.
kind

string

The type of the API resource. For claimEvent resources, this value is youtubePartner#claimEvent.
type

string

Type of the event. Acceptable values include:

  • appeal_cancelled - A dispute appeal was cancelled.
  • claim_close - The claim was closed.
  • claim_create - The claim was created.
  • claim_create_pending - The claim was created in pending state.
  • claim_reinstate - The claim was reinstated.
  • claim_release - The claim was released.
  • claim_retract - The claim was retracted.
  • claim_update - The claim was updated.
  • delayed_takedown - A delayed takedown was initiated.
  • dispute_appeal - A claim dispute was appealed.
  • dispute_create - A claim was disputed by the user.
  • retraction_request_create - A claim retraction request was created.
  • retraction_request_expire - A claim retraction request expired.
  • retraction_request_reject - A claim retraction request was rejected.
  • takedown_request_create - A video takedown request was created.
  • takedown_request_pushback - A video takedown request received pushback.
  • takedown_request_retract - A video takedown request was retracted.
  • video_takedown_strike - A video takedown strike was applied.
reason

string

Reason for the event. Acceptable values include:

  • appeal_expired - Appeal review period expired.
  • asset_transfer_request - Event relates to an asset ownership transfer.
  • channel_allowlisted - Channel was allowlisted.
  • closed_disabled_monetization - Monetization was disabled on channel.
  • closed_manually - Closed manually by the partner.
  • closed_manually_by_other_partner - Closed manually by another partner.
  • closed_noadsense - Owner does not have an active AdSense account.
  • closed_own_video_match - Channel owner is an owner of the match claim.
  • closed_reference_conflict - Reference lost a conflict against another reference.
  • closed_video_modification - Closed due to video content modification.
  • counter_received - Counter notice was received.
  • dispute_resolution - Claim dispute was resolved.
  • licensed_off_platform - Claim is covered by an off-platform license.
  • ownership_removed - Ownership was removed from the asset.
  • reference_removed - Reference file was removed.
  • replaced - Claim was replaced by another claim.
  • review_expired - Review period expired.
  • synthetic_content_confirmed - Synthetic content was confirmed.
  • video_removed - Video was removed by the uploader.
source

object (Source)

Data related to source of the event.
typeDetails

object (TypeDetails)

Details of event's type.

Source

Claim source

JSON representation 
{
  "type": string,
  "userEmail": string,
  "contentOwnerId": string
}
Fields
type

string

Type of the event source. Acceptable values are:

  • batch_tool - The event was triggered through a bulk operation.
  • bulk_update - The event was triggered through a bulk update.
  • cms_user - The event was triggered by a Content Manager user.
  • dropbox_feed - The event was triggered through SFTP or dropbox feed.
  • yt_admin - The event was triggered by a YouTube administrator.
  • yt_user - The event was triggered by a YouTube user.
userEmail

string

Email of user who initiated the event.
contentOwnerId

string

Id of content owner that initiated the event.

TypeDetails

Details of event's type.

JSON representation 
{
  "disputeReason": string,
  "updateStatus": string,
  "disputeNotes": string,
  "appealExplanation": string
}
Fields
disputeReason

string

Dispute reason for dispute_create and dispute_appeal events. Acceptable values are:

  • authorized - The user has permission to use the claimed content.
  • fair_use - The content use qualifies as fair use or fair dealing.
  • misidentification - The content was misidentified.
  • likeness_exception - The claimed content qualifies under a likeness exception (such as parody, satire, or editorial depiction).
  • original - The user owns all rights to the original content.
  • public_domain - The content is in the public domain.
updateStatus

string

Status that was a result of update for claim_update event.

Acceptable values are:

  • active
  • inactive
  • pending
disputeNotes

string

Dispute notes for dispute_create events.
appealExplanation

string

Appeal explanations for dispute_appeal event.

Methods

get

 Retrieves the claim history for a specified claim.