REST Resource: claimHistory
Stay organized with collections
Save and categorize content based on your preferences.
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.
ClaimEvent
A claimEvent
resource represents a single event in claim's life cycle.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eclaimHistory\u003c/code\u003e resources detail the lifecycle of a claim, including events like creation, updates, disputes, and closure.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eclaimEvent\u003c/code\u003e resource represents a specific occurrence in a claim's history, including details like the event time, type, reason, and source.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSource\u003c/code\u003e resource specifies information related to the origin of a \u003ccode\u003eclaimEvent\u003c/code\u003e, including the event source type, user email, and content owner ID.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTypeDetails\u003c/code\u003e resource provides specifics about the event's type, such as the dispute reason, update status, dispute notes, or appeal explanations.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eget\u003c/code\u003e method within the \u003ccode\u003eclaimHistory\u003c/code\u003e allows retrieving the full history for a specified claim.\u003c/p\u003e\n"]]],["The provided content outlines the structure and data associated with claim history in an API. Key components include: `ClaimHistory`, which tracks a claim's lifecycle events; `ClaimEvent`, representing a single event with details like time, type, reason, `Source`, and `TypeDetails`. `Source` defines the origin of an event, and `TypeDetails` specifies event-type-specific information, such as dispute reasons or update statuses. The `get` method is available to retrieve a claim's history.\n"],null,["# REST Resource: claimHistory\n\n- [Resource: ClaimHistory](#ClaimHistory)\n - [JSON representation](#ClaimHistory.SCHEMA_REPRESENTATION)\n- [ClaimEvent](#ClaimEvent)\n - [JSON representation](#ClaimEvent.SCHEMA_REPRESENTATION)\n- [Source](#Source)\n - [JSON representation](#Source.SCHEMA_REPRESENTATION)\n- [TypeDetails](#TypeDetails)\n - [JSON representation](#TypeDetails.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: ClaimHistory\n----------------------\n\nA `claimHistory` resource identifies the set of events that describe a claim's life cycle, such as the claim being created, updated, disputed, or closed.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"event\": [ { object (/youtube/partner/reference/rest/v1/claimHistory#ClaimEvent) } ], \"id\": string, \"uploaderChannelId\": string } ``` |\n\n| Fields ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. For `claimHistory` resources, this value is `youtubePartner#claimHistory`. |\n| `event[]` | `object (`[ClaimEvent](/youtube/partner/reference/rest/v1/claimHistory#ClaimEvent)`)` A list of claim history events. |\n| `id` | `string` The ID that YouTube assigns and uses to uniquely identify the claim. |\n| `uploaderChannelId` | `string` The external channel id of claimed video's uploader. |\n\nClaimEvent\n----------\n\nA `claimEvent` resource represents a single event in claim's life cycle.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"time\": string, \"kind\": string, \"type\": string, \"reason\": string, \"source\": { object (/youtube/partner/reference/rest/v1/claimHistory#Source) }, \"typeDetails\": { object (/youtube/partner/reference/rest/v1/claimHistory#TypeDetails) } } ``` |\n\n| Fields ||\n|---------------|--------------------------------------------------------------------------------------------------------------------|\n| `time` | `string` The time when the event occurred. |\n| `kind` | `string` The type of the API resource. For `claimEvent` resources, this value is `youtubePartner#claimEvent`. |\n| `type` | `string` Type of the event. |\n| `reason` | `string` Reason of the event. |\n| `source` | `object (`[Source](/youtube/partner/reference/rest/v1/claimHistory#Source)`)` Data related to source of the event. |\n| `typeDetails` | `object (`[TypeDetails](/youtube/partner/reference/rest/v1/claimHistory#TypeDetails)`)` Details of event's type. |\n\nSource\n------\n\nClaim source\n\n| JSON representation |\n|---------------------------------------------------------------------------|\n| ``` { \"type\": string, \"userEmail\": string, \"contentOwnerId\": string } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------|\n| `type` | `string` Type of the event source. |\n| `userEmail` | `string` Email of user who initiated the event. |\n| `contentOwnerId` | `string` Id of content owner that initiated the event. |\n\nTypeDetails\n-----------\n\nDetails of event's type.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------|\n| ``` { \"disputeReason\": string, \"updateStatus\": string, \"disputeNotes\": string, \"appealExplanation\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------|\n| `disputeReason` | `string` Dispute reason for `dispute_create` and `dispute_appeal` events. |\n| `updateStatus` | `string` Status that was a result of update for `claim_update` event. |\n| `disputeNotes` | `string` Dispute notes for `dispute_create` events. |\n| `appealExplanation` | `string` Appeal explanations for `dispute_appeal` event. |\n\n| Methods ------- ||\n|----------------------------------------------------------------|----------------------------------------------------|\n| ### [get](/youtube/partner/reference/rest/v1/claimHistory/get) | Retrieves the claim history for a specified claim. |"]]
