Available Amazon Data Portability LWA Scopes
The Available Amazon Data Portability LWA Scopes defines the supported type of data that the customer is authorizing to give access to your Application.
Scopes are divided in three categories, Category-1, Category-2 and Category-3, based on the type of the customer data in each scope.
- Category-1 Scopes
- Category-2 Scopes
- Advertising preferences and clicked ads
- Alexa shopping lists
- Contact information
- Custom products
- Customer attributes
- Digital order returns
- Digital orders
- Digital redemptions
- Digital software and video games downloads
- Digital software and video games entitlements
- Digital software and video games subscriptions
- Digital subscription bills
- Digital subscriptions
- Garage vehicles
- Gift lists
- Lists
- Physical order returns
- Physical orders
- Physical product subscriptions
- Product substitution preferences
- Search history
- Shopping basket
- Shopping profile preferences
- Sports interests
- Category-3 Scopes
Category-1 Scopes
To gain access to Category-1 scopes, you will complete the business identity verification in Step 2. Identity and security assessment.
Customer Profile
This scope includes Amazon customer's profile information like profile photo, cover photo, bio, and configured privacy settings.
Identifiers:
- Login with Amazon Scope Name:
portability::customer_profile
- Amazon Data Portability
scopeId
:portability-customer-profile
Customer profile
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
images |
The customer's avatar and cover photos. | N/A |
images.url |
The image url. | https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png |
images.type |
The image type. | coverPhoto |
privacySettings |
The privacy settings set in the Edit Privacy page to show or hide certain widgets or content created in the profile page. The values sometimes have a default value, and some of these settings are deprecated or could be a feature that's not available in all marketplaces. | N/A |
privacySettings.activityOnYourProfileVisibility |
The visibility of the activity timeline. | public |
privacySettings.sensitiveActivityVisibility |
The visibility of sensitive items. | public |
privacySettings.babyRegistryVisibility |
The visibility of the baby registry. | private |
privacySettings.topReviewerBadgesVisibility |
The visibility of the top reviewer badge. | public |
privacySettings.topContributorStatusVisibility |
The visibility of the top contributor status. | private |
privacySettings.whoYouFollowVisibility |
The visibility of the list of entities a customer follows. | private |
privacySettings.publicWishListVisibility |
The visibility of the public wishlist. | public |
privacySettings.reviewsVisibility |
The visibility of the reviews. | public |
privacySettings.weddingRegistryVisibility |
The visibility of the wedding registry. | private |
profileAttributes |
The profile attributes. | N/A |
profileAttributes.location |
The location. | Germany |
profileAttributes.publicName |
The name set on the profile page. | John Doe |
profileAttributes.bio |
The bio. | Professional Tester |
profileAttributes.occupation |
The occupation. | QA Engineer |
profileAttributes.website |
The website. | www.personal-website.com |
profileAttributes.facebookLink |
The link to the Facebook account. | https://www.facebook.com/username |
profileAttributes.pinterestLink |
The link to the Pinterest account. | https://pinterest.com/username |
profileAttributes.twitterLink |
The link to the Twitter account. | https://www.twitter.com/username |
profileAttributes.instagramLink |
The link to the Instagram account. | https://www.instagram.com/username |
profileAttributes.youtubeLink |
The link to the YouTube account. | https://www.youtube.com/channel/channel |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Customer Profile",
"description": "Includes customer profile information, such as profile photo, cover photo, bio or customer-configured privacy settings.",
"type": "object",
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"images": {
"description": "The customer's profile and cover photos.",
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The image url (e.g., https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png)."
},
"type": {
"description": "The image type (e.g., coverPhoto).",
"type": "string",
"enum": [
"coverPhoto",
"profilePhoto"
]
}
},
"required": [
"url",
"type"
],
"unevaluatedProperties": false
}
},
"privacySettings": {
"description": "The privacy settings set in the Edit Privacy page to show or hide certain widgets or content created in the profile page. The values sometimes have a default value, and some of these settings are deprecated or could be a feature that's not available in all marketplaces.",
"type": "object",
"properties": {
"activityOnYourProfileVisibility": {
"description": "The visibility of the activity timeline (e.g., public).",
"type": "string",
"enum": [
"private",
"public"
]
},
"sensitiveActivityVisibility": {
"description": "The visibility of sensitive items (e.g., public).",
"type": "string",
"enum": [
"private",
"public"
]
},
"babyRegistryVisibility": {
"description": "The visibility of the baby registry (e.g., private).",
"type": "string",
"enum": [
"private",
"public"
]
},
"topReviewerBadgesVisibility": {
"description": "The visibility of the top reviewer badge (e.g., public).",
"type": "string",
"enum": [
"private",
"public"
]
},
"topContributorStatusVisibility": {
"description": "The visibility of the top contributor status (e.g., private).",
"type": "string",
"enum": [
"private",
"public"
]
},
"whoYouFollowVisibility": {
"description": "The visibility of the list of entities a customer follows (e.g., private).",
"type": "string",
"enum": [
"private",
"public"
]
},
"publicWishListVisibility": {
"description": "The visibility of the public wishlist (e.g., public).",
"type": "string",
"enum": [
"private",
"public"
]
},
"reviewsVisibility": {
"description": "The visibility of the reviews (e.g., public).",
"type": "string",
"enum": [
"private",
"public"
]
},
"weddingRegistryVisibility": {
"description": "The visibility of the wedding registry (e.g., private).",
"type": "string",
"enum": [
"private",
"public"
]
},
"unevaluatedProperties": false
}
},
"profileAttributes": {
"description": "The profile attributes.",
"type": "object",
"properties": {
"location": {
"description": "The location (e.g., Germany).",
"type": "string"
},
"publicName": {
"description": "The name set on the profile page (e.g., John Doe).",
"type": "string"
},
"bio": {
"description": "The bio (e.g., Professional Tester).",
"type": "string"
},
"occupation": {
"description": "The occupation (e.g., QA Engineer).",
"type": "string"
},
"website": {
"description": "The website (e.g., www.personal-website.com).",
"type": "string"
},
"facebookLink": {
"description": "The link to the facebook account (e.g., https://www.facebook.com/username).",
"type": "string"
},
"pinterestLink": {
"description": "The link to the pinterest account (e.g., https://pinterest.com/username).",
"type": "string"
},
"twitterLink": {
"description": "The link to the twitter account (e.g., https://www.twitter.com/username).",
"type": "string"
},
"instagramLink": {
"description": "The link to the instagram account (e.g., https://www.instagram.com/username).",
"type": "string"
},
"youtubeLink": {
"description": "The link to the youtube account (e.g., https://www.youtube.com/channel/channel).",
"type": "string"
}
},
"required": [
"publicName"
],
"unevaluatedProperties": false
}
},
"required": [
"eventDate",
"profileAttributes"
]
}
Sample data based on the sample schema:
{
"eventDate": "2021-09-29T11:04:43.305Z",
"images": [
{
"url": "https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png",
"type": "coverPhoto"
}
],
"privacySettings": {
"activityOnYourProfileVisibility": "public",
"sensitiveActivityVisibility": "public",
"babyRegistryVisibility": "private",
"topReviewerBadgesVisibility": "public",
"topContributorStatusVisibility": "private",
"whoYouFollowVisibility": "private",
"publicWishListVisibility": "public",
"reviewsVisibility": "public",
"weddingRegistryVisibility": "private"
},
"profileAttributes": {
"location": "Germany",
"publicName": "John Doe",
"bio": "Professional Tester",
"occupation": "QA Engineer",
"website": "www.personal-website.com",
"facebookLink": "https://www.facebook.com/username",
"pinterestLink": "https://pinterest.com/username",
"twitterLink": "https://www.twitter.com/username",
"instagramLink": "https://www.instagram.com/username",
"youtubeLink": "https://www.youtube.com/channel/channel"
}
}
Product reviews
This scope includes Amazon customer's product reviews with details like text, photos, videos, and star ratings.
Identifiers:
- Login with Amazon Scope Name:
portability::product_reviews
- Amazon Data Portability
scopeId
:portability-product-reviews
Product reviews
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
asin |
The identifier of the reviewed product, a unique ten-digit alphanumeric code. | B08FXVRFL9 |
versionID |
The sequential identifier for the review version. | 3 |
imageURLs |
The URL of the images uploaded and stored in the Amazon systems. | https://m.media-amazon.com/images/I/61dJstwX20L._SL1600_.jpg |
videoURLs |
The URL of the video uploaded and stored in the Amazon systems. | https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4 |
starRating |
The numeric rating value in the range of 1-5. It relates to the number of stars assigned to the product. | 5 |
text |
The text part of the review. | Pretty good puzzle |
title |
The title of the review. | Recommended |
featureRatings |
The list of pairs of product attributes with the numeric rating value in reference to the product. | Flavor:4 |
status |
The status of the review. | approved |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Product Reviews",
"type": "array",
"description": "Includes product reviews provided by the customer, with details such as the review text, image references, video references and rating insights.",
"items": {
"type": "object",
"description": "Review contents",
"properties": {
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"pattern": "^[A-Z]{2}$"
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"asin": {
"type": "string",
"description": "The identifier of the reviewed product, a unique ten-digit alphanumeric code (e.g., B08FXVRFL9)."
},
"versionID": {
"type": "integer",
"description": "The sequential identifier for the review version. (e.g., 3)."
},
"imageURLs": {
"type": "array",
"description": "The URL of the images uploaded and stored in the Amazon systems. (e.g., https://m.media-amazon.com/images/I/61dJstwX20L._SL1600_.jpg).",
"items": {
"type": "string"
}
},
"videoURLs": {
"type": "array",
"description": "The URL of the video uploaded and stored in the Amazon systems (e.g., https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4).",
"items": {
"type": "string"
}
},
"starRating": {
"type": "integer",
"description": "The numeric rating value in the range of 1-5. It relates to the number of stars assigned to the product (e.g., 5)."
},
"text": {
"type": "string",
"description": "The text part of the review (e.g., Pretty good puzzle)."
},
"title": {
"type": "string",
"description": "The title of the review (e.g., Recommended)."
},
"featureRatings": {
"type": "array",
"description": "The list of pairs of product attributes with the numeric rating value in reference to the product (e.g., Flavor:4).",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"description": "The status of the review (e.g., approved)."
}
},
"required": [
"marketplace",
"eventDate",
"asin",
"versionID"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"asin": "B08FXVRFL9",
"versionID": 3,
"imageURLs": [
"https://m.media-amazon.com/images/I/61dJstwX20L._SL1600_.jpg"
],
"videoURLs": [
"https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4"
],
"starRating": 5,
"text": "Pretty good puzzle",
"title": "Recommended",
"featureRatings": [
"Flavor:4"
],
"status": "approved"
}
]
Seller feedback
This scope includes Amazon customer's feedback provided to third-party sellers, including details like feedback text, ratings, and customer selected reason codes.
Identifiers:
- Login with Amazon Scope Name:
portability::seller_feedback
- Amazon Data Portability
scopeId
:portability-seller-feedback
Seller feedback
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
feedbackDate |
The date when the feedback was given, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
feedbackRating |
The star rating provided by the customer. | 1 |
feedbackText |
The feedback text provided by the customer. | Lorem Ipsum |
dealAgain |
The customer provided response stating if they will purchase from the seller again. | true |
itemArrivedOnTime |
The customer provided response stating if the item arrived on time. | true |
promptOnCorteousService |
The customer provided response stating if the communication from the seller was good. | false |
itemAsDescribed |
The customer provided response stating if the item was received as described by the seller. | true |
whatWentWrong |
The customer selected reason code indicating which issue they had with their order. | Wrong Version or Size |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Seller Feedback",
"description": "Includes feedback provided by the customer to the third-party sellers, including details such as feedback text, ratings, and customer selected reason codes. ",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"type": "string"
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"feedbackDate": {
"description": "The date when the feedback was given, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"feedbackRating": {
"description": "The star rating provided by the customer (e.g., 4).",
"enum": [
1,
2,
3,
4,
5
]
},
"feedbackText": {
"description": "The feedback text provided by the customer (e.g., Lorem Ipsum).",
"type": "string"
},
"dealAgain": {
"description": "The customer provided response stating if they will purchase from the seller again (e.g., true).",
"type": "boolean"
},
"itemArrivedOnTime": {
"description": "The customer provided response stating if the item arrived on time (e.g., true).",
"type": "boolean"
},
"promptCourteousService": {
"description": "The customer provided response stating if the communication from the seller was good (e.g., false).",
"type": "boolean"
},
"itemAsDescribed": {
"description": "The customer provided response stating if the item was received as described by the seller (e.g., true).",
"type": "boolean"
},
"whatWentWrong": {
"enum": [
"Completely Wrong Item",
"Damaged Defective Other",
"Did not receive my package",
"Due to poor packaging",
"Issue Not Listed Above",
"Item Not As Described",
"Just Not Happy With My Product",
"Received my package late",
"Return or Refund Issue",
"Something was missing",
"Wrong Version or Size"
],
"description": "The customer selected reason code indicating which issue they had with their order (e.g., Wrong Version or Size)."
}
},
"required": [
"marketplace",
"eventDate",
"feedbackDate",
"feedbackRating"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"feedbackDate": "2021-09-29T11:04:43.305Z",
"feedbackRating": 1,
"feedbackText": "Reliable shop",
"dealAgain": true,
"itemArrivedOnTime": true,
"promptCourteousService": false,
"itemAsDescribed": true,
"whatWentWrong": "Wrong Version or Size"
}
]
Category-2 Scopes
To gain access to Category-2 scopes, you will complete the business identity and data security verification in Step 2. Identity and security assessment.
Advertising preferences and clicked ads
This scope includes details about Amazon customers’ clicked ads and whether they have opted out of interest based advertising.
Identifiers:
- Login with Amazon Scope Name:
portability::advertising_insights
- Amazon Data Portability
scopeId
:portability-advertising-insights
Advertising clicks
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
advertiserName |
The name of the advertiser that owns the ad which was clicked by the customer. | MF Network Tech |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Advertising - Clicks",
"description": "Includes details about ads clicked by the customer.",
"type": "array",
"items": {
"type": "object",
"properties": {
"advertiserName": {
"type": "string",
"description": "The name of the advertiser that owns the ad which was clicked by the customer (e.g., MF Network Tech)."
},
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
}
},
"unevaluatedProperties": false,
"required": [
"advertiserName",
"marketplace",
"eventDate"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"advertiserName": "MF Network Tech"
}
]
Advertising interest based opt outputs
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
isOptedOut |
The flag that specifies whether the customer has opted out of interest based advertising. | false |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Advertising - Interest Based Opt Outs",
"description": "Includes details about the customer's interest based advertising opt out status.",
"type": "array",
"items": {
"type": "object",
"properties": {
"isOptedOut": {
"type": "boolean",
"description": "The flag that specifies whether the customer has opted out of interest based advertising (e.g., false)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
}
},
"unevaluatedProperties": false,
"required": [
"marketplace",
"isOptedOut",
"eventDate"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"isOptedOut": false
}
]
Alexa shopping lists
This scope includes Amazon customer's Alexa digital grocery shopping lists with details like name, type, and origin of recipe.
Identifiers:
- Login with Amazon Scope Name:
portability::alexa_shopping_lists
- Amazon Data Portability
scopeId
:portability-alexa-shopping-lists
Alexa shopping lists
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
listName |
The name of the shopping list. | My Shopping List |
listType |
The type of the shopping list. | SHOP |
listItems |
The items in the shopping list. | N/A |
listItems.itemName |
The name of the item in the list. | cake |
listItems.isCompleted |
The flag that specifies if the item is completed. | false |
isArchived |
The flag that specifies if the list is archived. | false |
sourceUrl |
The source URL of the recipe. | www.recipes.com |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Alexa Shopping Lists",
"type": "array",
"description": "Includes the digital grocery shopping lists created by the customer, with details such as name, type or origin of a recipe, if applicable.",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"listName": {
"type": "string",
"description": "The name of the shopping list (e.g., My Shopping List)."
},
"listType": {
"type": "string",
"description": "The type of the shopping list (e.g., SHOP).",
"enum": [
"SHOP",
"TODO",
"CUSTOM",
"RECIPE",
"RECIPE_DEF"
]
},
"listItems": {
"type": "array",
"description": "The items in the shopping list.",
"items": {
"type": "object",
"properties": {
"itemName": {
"type": "string",
"description": "The name of the item in the list (e.g., cake)."
},
"isCompleted": {
"type": "boolean",
"description": "The flag that specifies if the item is completed (e.g., false)."
}
},
"required": [
"itemName",
"isCompleted"
],
"unevaluatedProperties": false
}
},
"isArchived": {
"type": "boolean",
"description": "The flag that specifies if the list is archived (e.g., false)."
},
"sourceUrl": {
"type": "string",
"description": "The source URL of the recipe (e.g., www.recipes.com)."
}
},
"required": [
"eventDate",
"listName",
"listType",
"isArchived"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2021-09-29T11:04:43.305Z",
"listName": "My Shopping List",
"listType": "SHOP",
"isArchived": false,
"listItems": [
{
"itemName": "cake",
"isCompleted": false
}
],
"sourceUrl": "www.recipes.com"
}
]
Contact information
This scope includes Amazon customer's contact information like email and phone number.
Identifiers:
- Login with Amazon Scope Name:
portability::contact_information
- Amazon Data Portability
scopeId
:portability-contact-information
Contact information
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
communicationMedium |
The medium of communication like sms, voice, email. | SMS |
email |
The email of the user. | nobody@amazon.com |
countryCode |
The country code of phone number of the user formatted according to ISO 3166-1 alpha-2 standard. | DE |
extension |
The extension of phone number of the user. | +49 |
localPhoneNumber |
The phone number of the user. | 123456789 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Contact Information",
"description": "Includes the contact information configured by the customer, such as email or phone number.",
"type": "array",
"items": {
"type": "object",
"properties": {
"communicationMedium": {
"description": "The medium of communication like (e.g., SMS, VOICE, EMAIL).",
"type": "string"
},
"email": {
"description": "The email of the user (e.g., nobody@amazon.com).",
"type": "string"
},
"countryCode": {
"description": "The country code of phone number of the user formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"type": "string"
},
"extension": {
"description": "The extension of phone number of the user (e.g., +49).",
"type": "string"
},
"localPhoneNumber": {
"description": "The phone number of the user (e.g., 123456789).",
"type": "string"
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
}
},
"anyOf": [
{
"required": [
"communicationMedium",
"email",
"eventDate"
]
},
{
"required": [
"communicationMedium",
"localPhoneNumber",
"eventDate"
]
}
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2021-09-29T11:04:43.305Z",
"communicationMedium": "SMS",
"countryCode": "DE",
"extension": "+49",
"localPhoneNumber": "123456789"
}
]
Custom products
This scope includes Amazon customer's list of customized products with details like product name and personalized text.
Identifiers:
- Login with Amazon Scope Name:
portability::custom_products
- Amazon Data Portability
scopeId
:portability-custom-products
Custom products
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
orderId |
The order identifier of the product purchased by the customer, populated only if source is ORDER. | 112-3701535-1629840 |
sourceId |
The identifier of the source containing the item. | Saved for later |
source |
The source of this record. | CART |
asin |
The identifier of the product that the customer added to their lists, cart or purchased, a unique ten-digit alphanumeric code. | B0B8DTFX3F |
productName |
The product title that the customer added to their lists, carts or purchased. | Personalized Coffee Mug - Add text to our Custom Mugs |
customizations |
The customization list provided by the customer. | N/A |
customizations.textInputs |
The list of text customizations provided by the customer. | Mason Manor, Georgia |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Custom Products",
"description": "Includes list of customized products, with details such as product name and customization text.",
"type": "array",
"items": {
"type": "object",
"required": [
"source",
"eventDate",
"asin",
"productName",
"marketplace",
"customizations"
],
"properties": {
"source": {
"description": "The source of this record (e.g., CART).",
"type": "string"
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string"
},
"asin": {
"description": "The identifier of the product that the customer added to their lists, cart or purchased, a unique ten-digit alphanumeric code (e.g., B0B8DTFX3F).",
"type": "string"
},
"productName": {
"description": "The product title that the customer added to their lists, carts or purchased (e.g., Personalized Coffee Mug - Add text to our Custom Mugs)",
"type": "string"
},
"marketplace": {
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"customizations": {
"description": "The customization list provided by the customer.",
"type": "object",
"properties": {
"textInputs": {
"description": "The list of text customizations provided by the customer (e.g., Mason Manor, Georgia).",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"oneOf": [
{
"properties": {
"orderId": {
"description": "The order identifier of the product purchased by the customer, populated only if source is ORDER (e.g., 112-3701535-1629840).",
"type": "string"
}
},
"required": [
"orderId"
]
},
{
"properties": {
"sourceId": {
"description": "The identifier of the source containing the item (e.g., Saved for later).",
"type": "string"
}
},
"required": [
"sourceId"
]
}
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"source": "CART",
"sourceId": "Saved for later",
"asin": "B0B8DTFX3F",
"productName": "Personalized Coffee Mug - Add text to our Custom Mugs",
"customizations": {
"textInputs": [
"Mason Manor",
"Georgia"
]
}
}
]
Customer attributes
This scope includes Amazon customer's personal attributes like language preference and currency preference.
Identifiers:
- Login with Amazon Scope Name:
portability::customer_attributes
- Amazon Data Portability
scopeId
:portability-customer-attributes
Customer attributes
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone. | 2021-09-29T11:04:43Z |
currencyOfPreference |
The currency code for the preferred currency, formatted according to ISO 4217 standard. | EUR |
languageOfPreference |
The language code for the preferred language, formatted according to ISO 639-1 for the language and ISO 3166-1 for the country code. | en-US |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Customer Attributes",
"description": "Includes personal attributes configured by the customer, such as language and currency of preference.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"pattern": "^[A-Z]{2}$",
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ssZ - 2021-09-29T11:04:43Z)."
},
"currencyOfPreference": {
"type": "string",
"description": "The currency code for the preferred currency, formatted according to ISO 4217 standard (e.g., EUR)."
},
"languageOfPreference": {
"type": "string",
"description": "The language code for the preferred language, formatted according to ISO 639-1 for the language and ISO 3166-1 for the country code (e.g., en-US)."
}
},
"required": [
"marketplace",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43Z",
"currencyOfPreference": "EUR",
"languageOfPreference": "en-US"
}
Digital order returns
This scope includes Amazon customer's digital orders that were refunded and their associated refund transactions.
Identifiers:
- Login with Amazon Scope Name:
portability::digital_order_returns
- Amazon Data Portability
scopeId
:portability-digital-order-returns
Digital order returns transactions
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
orderId |
The identifier of the digital order for which the return was initiated. | D01-2832465-7013023 |
title |
The title of the product that was purchased. | Prime Membership Fee |
amountRefunded |
The amount that was refunded to the customer. | 3.99 |
baseCurrencyCode |
The currency code of the transaction formatted according to ISO 4217 standard. | EUR |
productName |
The product title that the customer added to their lists, carts or purchased. | Personalized Coffee Mug - Add text to our Custom Mugs |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Order Returns - Transactions",
"description": "Includes the list of digital transactions that were refunded by Amazon to the customer.",
"type": "array",
"items": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "The identifier of the digital order for which the return was initiated (e.g., D01-2832465-7013023)."
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"title": {
"type": "string",
"description": "The title of the product that was purchased (e.g., Prime Membership Fee)."
},
"amountRefunded": {
"description": "The amount that was refunded to the customer (e.g., 3.99).",
"type": "string"
},
"baseCurrencyCode": {
"type": "string",
"description": "The currency code of the transaction formatted according to ISO 4217 standard (e.g., EUR)."
}
},
"required": [
"orderId",
"marketplace",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"orderId": "D01-2832465-7013023",
"title": "Prime Membership Fee",
"amountRefunded": "3.99",
"baseCurrencyCode": "EUR"
}
]
Digital order returns monetary
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
orderId |
The identifier of the digital order for which the return was initiated. | D01-2832465-7013023 |
quantity |
The number of items that have been returned. | 2 |
reasonCode |
The reason code for the return. | UNWANTED |
baseCurrencyCode |
The currency code of the transaction formatted according to ISO 4217 standard. | EUR |
transactionAmount |
The amount that was refunded. | 3.99 |
baseCurrencyCode |
The currency code of the transaction formatted according to ISO 4217 standard. | EUR |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Order Returns - Monetary",
"description": "Includes the list of refund transactions initiated by Amazon to the customer.",
"type": "array",
"items": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "The identifier of the digital order for which the return was initiated (e.g., D01-2842565-8013723)."
},
"quantity": {
"description": "The number of items that have been returned (e.g., 2).",
"type": "number"
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"reasonCode": {
"description": "The reason code for the return (e.g., UNWANTED).",
"type": "string",
"enum": [
"WRONG_ITEM",
"BETTER_PRICE",
"QUALITY",
"INCOMPATIBLE",
"DOWNLOAD_PROBLEM",
"LATE_DELIVERY",
"DEFECTIVE",
"UNWANTED",
"DIGITAL_RIGHTS_RESTRICTIONS",
"OTHER",
"ACCIDENTAL_PURCHASE",
"INTERNAL_RETURN",
"OFFENSIVE_CONTENT",
"FAILED_EXTERNAL_INVOICE",
"EXCHANGE_UPGRADE_DOWNGRADE",
"SUBSCRIPTION_CANCELLATION"
]
},
"transactionAmount": {
"description": "The amount that was refunded (e.g., 3.99).",
"type": "string"
},
"baseCurrencyCode": {
"type": "string",
"description": "The currency code of the transaction formatted according to ISO 4217 standard (e.g., EUR)."
}
},
"required": [
"orderId",
"quantity",
"reasonCode",
"eventDate",
"marketplace"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"orderId": "D01-2832465-7013023",
"quantity": 2,
"reasonCode": "UNWANTED",
"transactionAmount": "3.99",
"baseCurrencyCode": "EUR"
}
]
Digital orders
This scope includes Amazon customer's digital order history with details like product name, prices paid, and quantity ordered.
Identifiers:
- Login with Amazon Scope Name:
portability::digital_orders
- Amazon Data Portability
scopeId
:portability-digital-orders
Digital orders items
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
baseCurrencyCode |
The currency code for the item price, formatted according to ISO 4217 standard. | EUR |
digitalOrderItemId |
The identifier of the item from the order. | CLCQKDL52GAHOP93C5I4FT0IPKV77D74HBD4SUCHAF7 |
installmentOurPrice |
The price of the installment, if it is an installment order. | 1.14 |
installmentOurPriceCurrencyCode |
The currency code for the installment order, formatted according to ISO 4217 standard. | EUR |
quantityOrdered |
The quantity the item was ordered. | 1 |
title |
The title of the item. | Paramount+ |
giftItem |
The flag that marks if the item was purchased as a gift. | false |
isOrderEligibleForPrimeBenefit |
The flag that marks if the order is eligible for prime benefits. | Yes |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Orders - Items",
"description": "Includes customer's digital order history items with details like product names, prices paid and quantity ordered.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"baseCurrencyCode": {
"type": "string",
"description": "The currency code for the item price, formatted according to ISO 4217 standard (e.g., EUR)."
},
"digitalOrderItemId": {
"type": "string",
"description": "The identifier of the item from the order (e.g., CLCQKDL52GAHOP93C5I4FT0IPKV77D74HBD4SUCHAF7)."
},
"installmentOurPrice": {
"type": "string",
"description": "The price of the installment, if it is an installment order (e.g., 1.14)."
},
"installmentOurPriceCurrencyCode": {
"type": "string",
"description": "The currency code for the installment order, formatted according to ISO 4217 standard (e.g., EUR)."
},
"quantityOrdered": {
"type": "number",
"description": "The quantity the item was ordered (e.g., 2)."
},
"title": {
"type": "string",
"description": "The title of the item (e.g., Paramount+)."
},
"giftItem": {
"type": "boolean",
"description": "The flag that marks if the item was purchased as a gift (e.g., true)."
},
"isOrderEligibleForPrimeBenefit": {
"description": "The flag that marks if the order is eligible for prime benefits (e.g., Yes).",
"type": "string",
"enum": [
"Yes",
"No"
]
}
},
"required": [
"marketplace",
"eventDate",
"baseCurrencyCode",
"digitalOrderItemId",
"quantityOrdered",
"giftItem"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "FR",
"eventDate": "2021-09-29T11:04:43.305Z",
"baseCurrencyCode": "EUR",
"digitalOrderItemId": "CLCQKDL52GAHOP93C5I4FT0IPKV77D74HBD4SUCHAF7",
"installmentOurPrice": "1.14",
"installmentOurPriceCurrencyCode": "EUR",
"quantityOrdered": 1,
"title": "Paramount+",
"giftItem": true,
"isOrderEligibleForPrimeBenefit": "Yes"
}
]
Digital orders history
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
orderId |
The unique identifier for a digital order which the product belongs to. | D01-4762016-7053852 |
isOrderAPreorder |
The flag that marks if a digital order was a pre-order. | false |
orderStatus |
The status code describing the order status. | SUCCESS |
relatedPhysicalOrderId |
The related physical order identifier, if it exists. | 111-5645993-5749423 |
subscriptionOrderType |
The type of the order if it is a subscription. | Subscription_Renewal |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Orders - History",
"description": "Includes customer's digital order history, with details like order status and whether it relates to a subscription.",
"type": "array",
"items": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "The unique identifier for a digital order which the product belongs to (e.g., D01-4762016-7053852)."
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"isOrderAPreorder": {
"description": "The flag that marks if a digital order was a pre-order (e.g., false).",
"type": "boolean"
},
"orderStatus": {
"description": "The status code describing the order status (e.g., SUCCESS).",
"type": "string",
"enum": [
"PENDING",
"CANCELLED_BY_AMAZON",
"PENDING_PREORDER_RELEASE",
"COMBINED_WITH_SIMILAR_ORDER",
"USER_CANCELED",
"N/A",
"SUCCESS"
]
},
"relatedPhysicalOrderId": {
"type": "string",
"description": "The related physical order identifier, if it exists. (e.g., 111-5645993-5749423)."
},
"subscriptionOrderType": {
"type": "string",
"description": "The type of the order if it is a subscription (e.g., Subscription_Renewal)."
}
},
"required": [
"orderId",
"marketplace",
"eventDate",
"isOrderAPreorder",
"orderStatus"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"orderId": "D01-4762016-7053852",
"isOrderAPreorder": false,
"orderStatus": "SUCCESS",
"relatedPhysicalOrderId": "111-5645993-5749423",
"subscriptionOrderType": "Subscription_Renewal"
}
]
Digital orders monetary
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
deliveryPacketId |
The identifier of the delivery packet, corresponding to a processed item. | GE0VRELSG8IJNJRAH6T6VB3PILHPIG0LCRKGHKJMD5SDG |
transactionAmount |
The monetary amount of the transaction. | 2.95 |
affectedItemQuantity |
The quantity of the item. | 5 |
fxCurrencyCode |
The foreign exchange currency code for the item price, formatted according to ISO 4217 standard. | EUR |
fxTransactionAmount |
The foreign exchange transaction amount. | 1.17 |
digitalOrderItemId |
The identifier of the item in the order. | VNCG8HRN6AU4I3HSIICNJL8RQU4IKODO816N05FHJ170PQGUJIDG |
baseCurrencyCode |
The currency code for the item price, formatted according to ISO 4217 standard. | EUR |
monetaryComponentTypeCode |
The type of the transaction. | Price Amount |
Schema Sample
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Orders - Monetary",
"description": "Includes customer's digital order history monetary information about each ordered item.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"format": "date-time"
},
"deliveryPacketId": {
"type": "string",
"description": "The identifier of the delivery packet, corresponding to a processed item (e.g., GE0VRELSG8IJNJRAH6T6VB3PILHPIG0LCRKGHKJMD5SDG)."
},
"transactionAmount": {
"type": "number",
"description": "The monetary amount of the transaction (e.g., 2.95)."
},
"affectedItemQuantity": {
"type": "number",
"description": "The quantity of the item (e.g., 5)."
},
"fxCurrencyCode": {
"type": "string",
"description": "The foreign exchange currency code for the item price, formatted according to ISO 4217 standard (e.g., EUR)."
},
"fxTransactionAmount": {
"type": "string",
"description": "The foreign exchange transaction amount (e.g., 1.17)."
},
"digitalOrderItemId": {
"type": "string",
"description": "The identifier of the item in the order (e.g., VNCG8HRN6AU4I3HSIICNJL8RQU4IKODO816N05FHJ170PQGUJIDG)."
},
"baseCurrencyCode": {
"type": "string",
"description": "The currency code for the item price, formatted according to ISO 4217 standard (e.g., EUR)."
},
"monetaryComponentTypeCode": {
"type": "string",
"description": "The type of the transaction (e.g., Price Amount)."
}
},
"required": [
"marketplace",
"eventDate",
"deliveryPacketId",
"affectedItemQuantity",
"digitalOrderItemId"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"deliveryPacketId": "GE0VRELSG8IJNJRAH6T6VB3PILHPIG0LCRKGHKJMD5SDG",
"transactionAmount": 2.95,
"affectedItemQuantity": 5,
"fxCurrencyCode": "EUR",
"fxTransactionAmount": "1.17",
"digitalOrderItemId": "VNCG8HRN6AU4I3HSIICNJL8RQU4IKODO816N05FHJ170PQGUJIDG",
"baseCurrencyCode": "EUR",
"monetaryComponentTypeCode": "Price Amount"
}
]
Digital redemptions
This scope includes Amazon customer's digital redemptions that were claimed as a gift certificate or a gift item.
Identifiers:
- Login with Amazon Scope Name:
portability::digital_redemptions
- Amazon Data Portability
scopeId
:portability-digital-redemptions
Digital redemptions
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
customerRole |
The role of the customer as part of which the redemption was created. | Sender |
orderId |
The unique identifier of the digital order as part of which this redemption was created. | D01-6692487-8533455 |
title |
The title of the gift item. | An Accidental Headship |
contentType |
The type of the content of the gift item. | eBook |
ourPriceAmount |
The price of the gift item. | 3.99 |
ourPriceCurrencyCode |
The currency code for the price amount, formatted according to ISO 4217 standard. | EUR |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Redemptions",
"description": "Includes the list of redemptions claimed by the customer as a gift certificate or gift item that may be purchased by the same or by a different customer.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string"
},
"customerRole": {
"description": "The role of the customer as part of which the redemption was created (e.g., Sender).",
"type": "string",
"enum": [
"Sender",
"Sender and Recipient",
"Recipient (Sender data removed to protect sender's privacy)"
]
},
"orderId": {
"type": "string",
"description": "The unique identifier of the digital order as part of which this redemption was created (e.g., D01-6692487-8533455)."
},
"title": {
"type": "string",
"description": "The title of the gift item (e.g., An Accidental Headship)."
},
"contentType": {
"description": "The type of the content of the gift item (e.g., eBook).",
"type": "string",
"enum": [
"Kindle Games & Active Content",
"Mp3",
"eBook",
"Mobile Apps",
"Amazon Local Voucher",
"Amazon Coins",
"Kindle Free Time Unlimited",
"Prime",
"Kindle Unlimited",
"Music Unlimited"
]
},
"ourPriceAmount": {
"description": "The price of the gift item (e.g., 3.99).",
"type": "number"
},
"ourPriceCurrencyCode": {
"type": "string",
"description": "The currency code for the price amount, formatted according to ISO 4217 standard (e.g., EUR)."
}
},
"required": [
"marketplace",
"customerRole",
"contentType",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"customerRole": "Sender",
"orderId": "D01-6692487-8533455",
"contentType": "eBook",
"title": "An Accidental Headship",
"ourPriceAmount": 3.99,
"ourPriceCurrencyCode": "EUR"
}
]
Digital software and video games downloads
This scope includes Amazon customer's digital software and video games download history.
Identifiers:
- Login with Amazon Scope Name:
portability::dsv_downloads
- Amazon Data Portability
scopeId
:portability-dsv-downloads
Digital software and video games downloads
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
title |
The product title that the customer purchased. | Tribes: Ascend [Game Connect] |
downloadHistoryState |
The status of the download. | READY |
downloadLastUpdateDate |
The date when the latest updates happened, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Software and Video Games - Downloads",
"description": "Includes the list of digital software and video games downloads.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"title": {
"description": "The product title that the customer purchased (e.g., Tribes: Ascend [Game Connect]).",
"type": "string"
},
"downloadHistoryState": {
"enum": [
"READY",
"IN_PROGRESS",
"PAUSED",
"CANCELLED",
"COMPLETED",
"ERROR",
"CHECKSUM_ERROR",
"USER_EXIT",
"REBOOT",
"REQ_UPGRADE",
"QUIT_BEFORE_START",
"CREATED",
"DEACTIVATED"
],
"description": "The status of the download (e.g., READY)."
},
"downloadLastUpdateDate": {
"type": "string",
"format": "date-time",
"description": "The date when the latest updates happened, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
}
},
"required": [
"marketplace",
"eventDate",
"title"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"title": "Tribes: Ascend [Game Connect]",
"downloadHistoryState": "READY",
"downloadLastUpdateDate": "2021-09-29T11:04:43.305Z"
}
]
Digital software and video games entitlements
This scope includes Amazon customer's entitlements in regard to digital software and video games.
Identifiers:
- Login with Amazon Scope Name:
portability::dsv_entitlements
- Amazon Data Portability
scopeId
:portability-dsv-entitlements
Digital software and video games entitlements
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
asin |
The identifier of the purchased product, a unique ten-digit alphanumeric code. | B07SR13WVW |
productName |
The name of the product that was purchased. | PhotoPad Photo Editing and Image Editor |
status |
The status of the entitlement. | Active |
entitlements |
The list of entitlements. | N/A |
entitlements.entitlementType |
The entitlement type. | Product Code |
entitlements.entitlementValue |
The entitlement value. | 1234-4567-02 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Software and Video Games - Entitlements",
"description": "Includes the list of entitlements in regards to digital software and video games.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"pattern": "^[A-Z]{2}$",
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string"
},
"asin": {
"description": "The identifier of the purchased product, a unique ten-digit alphanumeric code (e.g., B07SR13WVW).",
"type": "string"
},
"productName": {
"description": "The name of the product that was purchased (e.g., PhotoPad Photo Editing and Image Editor).",
"type": "string"
},
"status": {
"enum": [
"Active",
"Revoked"
],
"description": "The status of the entitlement (e.g., Active)."
},
"entitlements": {
"type": "array",
"description": "The list of entitlements.",
"items": {
"type": "object",
"properties": {
"entitlementType": {
"type": "string",
"description": "The entitlement type (e.g., Product Code)."
},
"entitlementValue": {
"type": "string",
"description": "The entitlement value (e.g., 1234-4567-02)."
}
},
"unevaluatedProperties": false,
"required": [
"entitlementType",
"entitlementValue"
]
}
}
},
"unevaluatedProperties": false,
"required": [
"marketplace",
"eventDate",
"asin",
"productName"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"asin": "B07SR13WVW",
"productName": "PhotoPad Photo Editing and Image Editor",
"status": "Active",
"entitlements": [
{
"entitlementType": "Product Code",
"entitlementValue": "1234-4567-02"
}
]
}
]
Digital software and video games subscriptions
This scope includes Amazon customer's digital software and video games subscriptions with details like their price, quantity, type auto-renewal, and expiration date.
Identifiers:
- Login with Amazon Scope Name:
portability::dsv_subscriptions
- Amazon Data Portability
scopeId
:portability-dsv-subscriptions
Digital software and video games subscriptions
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
autoRenewalEnabled |
The flag that indicates whether the license will auto renew at the end of contract cycle. | true |
contractInterval |
The current contract period interval. | MONTH |
contractIntervalsRemaining |
The number of intervals left on the contract, updated after each billing cycle. | 0 |
contractStartDate |
The date at which contract starts, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ) | 2021-09-29T11:04:43.305Z |
graceInterval |
The grace period interval for which the user is allowed to keep the subscription. | MONTH |
graceIntervalsRemaining |
The number of grace period intervals left on the contract, updated after each billing cycle. | 1 |
kind |
The kind of purchase. | REGISTRATION |
lastUpdateDate |
The date when the record was last updated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
licenseCreationDate |
The date the license was created, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
licenseStatus |
The current status of the license. | ACTIVATED |
licenseType |
The type of license the customer purchased. | SUBSCRIPTION |
productTitle |
The product title that the customer purchased. | Kaspersky VPN Secure Connection |
purchaseConfirmationStatus |
The flag that indicates if purchase was confirmed with the vendor. | SUCCESS |
purchaseDate |
The date when the record was purchased, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
purchaseState |
The flag that indicates the current state of purchase. | FULFILLED_OK |
purchaseStatus |
The current status of the purchase. | ACTIVE |
purchaseType |
The type of purchase. | SUBSCRIPTION |
quantity |
The quantity of items purchased. | 1 |
redemptionExpirationDate |
The date at which the redemption expires, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2022-09-29T11:04:43.305Z |
redemptionStatus |
The flag that indicates whether the user redeemed his/her license. | CLAIMED |
state |
The flag that specifies if current state of the purchase is valid. | VALID |
unitPrice |
The price per unit of the product(s) in default currency. | 23.95 |
username |
The identifier of user in the vendor system. | user1 |
vendorName |
The current name of the vendor. | Microsoft |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Software and Video Games - Subscriptions",
"description": "Includes the list of digital software and video games subscriptions with details like their price, quantity, type, auto-renewal or expiration date.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string"
},
"productTitle": {
"description": "The product title that the customer purchased (e.g., Kaspersky VPN Secure Connection).",
"type": "string"
},
"purchaseStatus": {
"description": "The current status of the purchase (e.g., ACTIVE).",
"type": "string",
"enum": [
"ACTIVE",
"CANCELLED"
]
},
"purchaseType": {
"description": "The type of purchase (e.g., SUBSCRIPTION).",
"type": "string"
},
"autoRenewalEnabled": {
"description": "The flag that indicates whether the license will auto renew at the end of contract cycle (e.g., true).",
"type": "boolean"
},
"licenseCreationDate": {
"description": "The date the license was created, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"licenseStatus": {
"description": "The current status of the license (e.g., ACTIVATED).",
"type": "string",
"enum": [
"ACTIVATED",
"UNASSIGNED",
"REVOKED",
"REDEEMED"
]
},
"contractStartDate": {
"format": "date-time",
"description": "The date at which contract starts, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string"
},
"redemptionExpirationDate": {
"description": "The date at which the redemption expires, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2022-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"redemptionStatus": {
"description": "The flag that indicates whether the user redeemed his/her license (e.g., CLAIMED).",
"enum": [
"UNCLAIMED",
"CLAIMED"
]
},
"quantity": {
"description": "The quantity of items purchased (e.g., 1).",
"type": "number"
},
"unitPrice": {
"description": "The price per unit of the product(s) in default currency (e.g., 23.95).",
"type": "number"
},
"licenseType": {
"description": "The type of license the customer purchased (e.g., SUBSCRIPTION).",
"type": "string"
},
"contractInterval": {
"description": "The current contract period interval (e.g., MONTH).",
"enum": [
"DAY",
"MONTH",
"YEAR"
]
},
"contractIntervalsRemaining": {
"description": "The number of intervals left on the contract, updated after each billing cycle (e.g., 0).",
"type": "number"
},
"graceInterval": {
"description": "The grace period interval for which the user is allowed to keep the subscription (e.g., MONTH).",
"enum": [
"DAY",
"MONTH",
"YEAR"
]
},
"kind": {
"description": "The kind of purchase (e.g., REGISTRATION).",
"type": "string"
},
"graceIntervalsRemaining": {
"description": "The number of grace period intervals left on the contract, updated after each billing cycle (e.g., 1).",
"type": "number"
},
"vendorName": {
"description": "The current name of the vendor (e.g., Microsoft).",
"type": "string"
},
"purchaseDate": {
"description": "The date when the record was purchased, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"lastUpdateDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was last updated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"purchaseConfirmationStatus": {
"description": "The flag that indicates if purchase was confirmed with the vendor (e.g., SUCCESS).",
"type": "string",
"enum": [
"SUCCESS",
"OK",
"FAILURE_PURCHASE_INVALID"
]
},
"purchaseState": {
"description": "The flag that indicates the current state of purchase (e.g., FULFILLED_OK).",
"type": "string",
"enum": [
"FULFILLED_OK",
"UNREFUNDED",
"REVOKED_FAILED",
"REVOKED_OK",
"ACTIVE",
"FULFILLING",
"FULFILLED"
]
},
"state": {
"description": "The flag that specifies if current state of the purchase is valid (e.g., VALID).",
"type": "string",
"enum": [
"VALID",
"INVALID",
"ACTIVE"
]
},
"username": {
"description": "The identifier of user in the vendor system (e.g., user1).",
"type": "string"
}
},
"required": [
"productTitle",
"marketplace",
"purchaseDate",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"productTitle": "Kaspersky VPN Secure Connection",
"purchaseStatus": "ACTIVE",
"purchaseType": "SUBSCRIPTION",
"autoRenewalEnabled": true,
"licenseCreationDate": "2022-09-29T11:04:43.305Z",
"licenseStatus": "ACTIVATED",
"contractStartDate": "2022-09-29T11:04:43.305Z",
"redemptionExpirationDate": "2022-09-29T11:04:43.305Z",
"redemptionStatus": "CLAIMED",
"quantity": 1,
"unitPrice": 23.95,
"licenseType": "SUBSCRIPTION",
"contractInterval": "MONTH",
"contractIntervalsRemaining": 0,
"graceInterval": "MONTH",
"kind": "REGISTRATION",
"graceIntervalsRemaining": 1,
"vendorName": "Microsoft",
"purchaseDate": "2021-09-29T11:04:43.305Z",
"lastUpdateDate": "2021-09-29T11:04:43.305Z",
"purchaseConfirmationStatus": "SUCCESS",
"purchaseState": "FULFILLED_OK",
"state": "VALID",
"username": "user1"
}
]
Digital subscription bills
This scope includes Amazon customer's digital subscription bills with details like currency, transaction amount, and cancellations.
Identifiers:
- Login with Amazon Scope Name:
portability::digital_subscription_bills
- Amazon Data Portability
scopeId
:portability-digital-subscription-bills
Digital subscription bills
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
baseCurrencyCode |
The currency code for the transaction amount, formatted according to ISO 4217 standard. | EUR |
cancellationRequested |
The flag that marks if cancellation was requested for the transaction. | true |
subscriptionId |
The subscription id associated with the transaction. | UI8H6PQE3BHLRLLGFI6G5A9GLI42T62RN96L54PUG4GJNBTPSLAG |
totalTransactionAmount |
The total amount of the transaction. | 7.99 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Subscription Bills",
"description": "Includes digital subscription bills associated to the customer's account, with details such as currency, transaction amount or cancellations.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string"
},
"baseCurrencyCode": {
"description": "The currency code for the transaction amount, formatted according to ISO 4217 standard (e.g., EUR).",
"type": "string"
},
"cancellationRequested": {
"description": "The flag that marks if cancellation was requested for the transaction (e.g., true).",
"type": "boolean"
},
"subscriptionId": {
"description": "The subscription id associated with the transaction (e.g., UI8H6PQE3BHLRLLGFI6G5A9GLI42T62RN96L54PUG4GJNBTPSLAG).",
"type": "string"
},
"totalTransactionAmount": {
"description": "The total amount of the transaction (e.g., 7.99).",
"type": "string"
}
},
"required": [
"marketplace",
"subscriptionId",
"totalTransactionAmount",
"baseCurrencyCode",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"baseCurrencyCode": "EUR",
"cancellationRequested": true,
"subscriptionId": "UI8H6PQE3BHLRLLGFI6G5A9GLI42T62RN96L54PUG4GJNBTPSLAG",
"totalTransactionAmount": "7.99"
}
]
Digital subscriptions
This scope includes Amazon customer's digital subscriptions, their status history, and the associated billing schedule.
Identifiers:
- Login with Amazon Scope Name:
portability::digital_subscriptions
- Amazon Data Portability
scopeId
:portability-digital-subscriptions
Digital subscriptions
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
subscriptionId |
The unique identifier for the digital subscription. | BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG |
autorenew |
The flag that specifies whether the subscription will renew automatically at the next subscription period. | true |
serviceProvider |
The identifier for the Amazon business that vends the subscription benefit. | Amazon Prime |
baseCurrencyCode |
The currency code for the price, formatted according to ISO 4217 standard. | EUR |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Subscriptions",
"description": "Includes the list of digital subscriptions and details like auto-renewal, provider of the service or the currency used for billing.",
"type": "array",
"items": {
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"description": "The unique identifier for the digital subscription (e.g., BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG)."
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"autorenew": {
"type": "boolean",
"description": "The flag that specifies whether the subscription will renew automatically at the next subscription period (e.g., true)."
},
"serviceProvider": {
"description": "The identifier for the Amazon business that vends the subscription benefit (e.g., Amazon Prime).",
"type": "string",
"enum": [
"Amazon Prime Business Auto Top Up",
"Audible",
"Amazon Photos",
"Prime Video Channels",
"Prime Video",
"Alexa Skillstore",
"AMASS Gameday Client",
"Amazon Family",
"Amazon Rapids",
"Amazon Student",
"Amazon Prime",
"Amazon Registry",
"Audible Sleep",
"Amazon DVD Rentals",
"Amazon Digital Data Plan",
"Amazon Kindle Newsstand",
"Amazon Kindle Active Content",
"Amazon Prime Fresh Free Trial",
"Audible Education",
"Blink Subscription",
"Blink",
"Preferred Buyers Club",
"Campus",
"Alexa Together",
"Comixology",
"Comixology Unlimited",
"Amazon Music Unlimited",
"Digital Software and Videogames",
"Groceries",
"Alexa Guard",
"Amazon Halo",
"IMdbPro",
"FreeTime Unlimited",
"Kindle Bookclubs",
"Kindle Guru",
"Kindle Scaling Game Day",
"Kindle Unlimited",
"Kindle Series",
"Kindle Series Subscriptions",
"Love Film Translation",
"Mobile Appstore Developer",
"Amazon AppStore",
"Oprah's Book Club",
"Amazon Cloud Cam",
"Product Insurance Warranties",
"Prime Fresh",
"Prime Pantry",
"Prime Stylist",
"Prime Book Box",
"Print Magazine",
"Ring",
"Funko",
"Subscribe With Amazon",
"Tempo",
"Prime Wireless Plans"
]
},
"baseCurrencyCode": {
"type": "string",
"description": "The currency code for the price, formatted according to ISO 4217 standard (e.g., EUR)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
}
},
"required": [
"subscriptionId",
"marketplace",
"eventDate",
"serviceProvider",
"baseCurrencyCode"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"subscriptionId": "BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG",
"autorenew": true,
"serviceProvider": "Amazon Prime",
"baseCurrencyCode": "EUR"
}
]
Digital subscriptions billing schedules
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
startPeriod |
The period that specifies when the default digital subscription item will be overridden with another. | 2 |
endPeriod |
The period when the digital subscription item will expire. | 2 |
price |
The price of the digital subscription item. | 3.99 |
baseCurrencyCode |
The currency code for the price, formatted according to ISO 4217 standard. | EUR |
subscriptionId |
The unique identifier for the digital subscription. | BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Subscriptions - Billing Schedules",
"description": "Includes the list of digital subscriptions schedule, like start period, end period, price and currency.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"startPeriod": {
"type": "string",
"description": "The period that specifies when the default digital subscription item will be overridden with another (e.g., 2)."
},
"endPeriod": {
"type": "string",
"description": "The period when the digital subscription item will expire (e.g., 2)."
},
"price": {
"description": "The price of the digital subscription item (e.g., 3.99).",
"type": "number"
},
"baseCurrencyCode": {
"type": "string",
"description": "The currency code for the price, formatted according to ISO 4217 standard (e.g., EUR)."
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier for the digital subscription (e.g., BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG)."
}
},
"required": [
"marketplace",
"eventDate",
"baseCurrencyCode",
"subscriptionId"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"startPeriod": "2",
"endPeriod": "2",
"price": 3.99,
"baseCurrencyCode": "EUR",
"subscriptionId": "BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG"
}
]
Digital subscriptions status history
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
subscriptionId |
The unique identifier for the digital subscription. | BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG |
subscriptionStatusStartDate |
The date when the subscription transitioned to current status, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ssZ). | 2018-01-20T12:57:00Z |
subscriptionStatusEndDate |
The date when the subscription transitioned out of current status, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ssZ). | 2019-02-05T12:57:00Z |
statusTransitionReason |
The reason why the subscription went into this status. | Subscription Pending Activation |
subscriptionStatus |
The state of the subscription. | Pending |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Digital Subscriptions - Status History",
"description": "Includes the history of the digital subscriptions status and insights like their status transition reason and their start and end dates.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier for the subscription (e.g., BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG)."
},
"subscriptionStatusStartDate": {
"type": "string",
"format": "date-time",
"description": "The date when the subscription transitioned to current status, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ssZ - 2018-01-20T12:57:00Z)."
},
"subscriptionStatusEndDate": {
"type": "string",
"format": "date-time",
"description": "The date when the subscription transitioned out of current status, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ssZ - 2019-02-05T12:57:00Z)."
},
"statusTransitionReason": {
"description": "The reason why the subscription went into this status (e.g., Subscription Pending Activation).",
"type": "string",
"enum": [
"Subscription Cancelled",
"Subscription Paused",
"Subscription Activated",
"Subscription Pending Activation"
]
},
"subscriptionStatus": {
"description": "The state of the subscription (e.g., Pending).",
"type": "string",
"enum": [
"Active",
"Pending",
"CancelPending",
"Cancelled",
"CreationPending",
"Paused",
"Suspended"
]
}
},
"required": [
"marketplace",
"eventDate",
"subscriptionId",
"statusTransitionReason",
"subscriptionStatus"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"subscriptionId": "BGI4EJVQBPLEP8U7BC721M3FFVLM8PN4TT42J0AFE5NB1L4L5FBG",
"subscriptionStatusStartDate": "2018-01-20T12:57:00Z",
"subscriptionStatusEndDate": "2019-02-05T12:57:00Z",
"statusTransitionReason": "Subscription Pending Activation",
"subscriptionStatus": "Pending"
}
]
Garage vehicles
This scope includes Amazon customer's list of vehicles from their virtual garage, with details like make, model, type, and mileage.
Identifiers:
- Login with Amazon Scope Name:
portability::garage_vehicles
- Amazon Data Portability
scopeId
:portability-garage-vehicles
Garage vehicles
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
make |
The brand name of the vehicle. | Hyundai |
model |
The model name of the vehicle. | I10 |
vehicleType |
The vehicle type used to recognize type of variant of vehicle created by the brand. | CAR |
engineType |
The vehicle engine type. | 1.2 (64 kW / 87 HP) |
vehicleId |
The ID/rank of the vehicle in customer's garage. | 2 |
variant |
The variant of the vehicle created by the brand. | II Hatchback - 08/13 |
mileage |
The mileage of the car. | 500 |
mileageUnit |
The unit used for measuring mileage of the car. | MILES |
mileageRate |
The average mileage of the car in a given time frame. | 500 |
mileageRateUnit |
The unit for measuring mileage rate. | MILES_PER_YEAR |
Sample schema:
{
"$schema": "http://json-schema.org/draft/2020-12/schema#",
"title": "Garage Vehicles",
"description": "Includes the list of vehicles from customer's virtual garage, with details like make, model, type or mileage.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"make": {
"type": "string",
"description": "The brand name of the vehicle (e.g., Hyundai)."
},
"model": {
"type": "string",
"description": "The model name of the vehicle (e.g., I10)."
},
"vehicleType": {
"type": "string",
"enum": [
"CAR",
"MOTORCYCLE"
],
"description": "The vehicle type used to recognize type of variant of vehicle created by the brand (e.g., CAR)."
},
"engineType": {
"type": "string",
"description": "The vehicle engine type (e.g., 1.2 (64 kW / 87 HP)."
},
"vehicleId": {
"type": "integer",
"description": "The ID/rank of the vehicle in customer's garage (e.g., 2)."
},
"variant": {
"type": "string",
"description": "The variant of the vehicle created by the brand (e.g., II Hatchback - 08/13)."
},
"mileage": {
"type": "integer",
"description": "The mileage of the car (e.g., 12)."
},
"mileageUnit": {
"type": "string",
"enum": [
"KILOMETERS",
"MILES"
],
"description": "The unit used for measuring mileage of the car (e.g., MILES)."
},
"mileageRate": {
"type": "integer",
"description": "The average mileage of the car in a given time frame (e.g., 500)."
},
"mileageRateUnit": {
"type": "string",
"enum": [
"KILOMETERS_PER_YEAR",
"MILES_PER_YEAR"
],
"description": "The unit for measuring mileage rate (e.g., MILES_PER_YEAR)."
}
},
"required": [
"marketplace",
"eventDate",
"make",
"model",
"vehicleType",
"engineType",
"variant",
"vehicleId"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"make": "Hyundai",
"model": "I10",
"vehicleType": "CAR",
"engineType": "1.2 (64 kW / 87 HP)",
"vehicleId": 2,
"variant": "II Hatchback - 08/13",
"mileage": 12,
"mileageUnit": "MILES",
"mileageRate": 500,
"mileageRateUnit": "MILES_PER_YEAR"
}
]
Gift lists
This scope includes Amazon customer's created gift lists with details such as their name, creation date, products in the lists, and gift registry.
Identifiers:
- Login with Amazon Scope Name:
portability::gifts
- Amazon Data Portability
scopeId
:portability-gifts
Gift lists
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
registryType |
The type of the gift list. | WEDDING |
isActive |
The flag that indicates whether the gift list is active. | true |
listEventDate |
The date of gift list event. | 2017-05-09 |
eventCity |
The city location of the event. | Wernigerode |
eventState |
The state location of the event. | Sachsen-Anhalt |
eventCountry |
The country location of the event. | Germany |
isSharedWithPartnerSite |
The flag that indicates whether the option to share the gift list with a partner is enabled. | false |
privacy |
The state that indicates the visibility of the gift list. | PUBLIC |
registryPurchases |
The registry of the purchases. | N/A |
registryPurchases.giftCardBalancePurchaseAmount |
The amount of a gift card that was used on the purchase amount. | 0.0 |
registryPurchases.purchaseDate |
The date of the gift list purchase, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2017-10-14T10:33:34.106Z |
registryPurchases.isCancelled |
The flag that indicates whether the order was cancelled. | false |
registryPurchases.purchaseAmount |
The cost of the purchase. | 64.99 |
registryPurchases.purchaseQuantity |
The quantity of the purchase. | 1 |
registryPurchases.product |
The purchased product details. | N/A |
registryPurchases.product.productName |
The purchased product name. | TV Wall Mount, JUSTSTONE TV Bracket Fits Most 26-65 Inch LED Flat & Curved TVs |
registryPurchases.product.asin |
The identifier of the purchased product, a unique ten-digit alphanumeric code. | B07YWSY5TG |
vanityUrls |
The list of vanity URLs. | N/A |
vanityUrls.isActive |
The flag that specifies whether the gift list is active or not. | false |
vanityUrls.url |
The vanity url. | https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4 |
vanityUrls.originalUrl |
The original vanity url. | https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Gift Lists",
"description": "Includes the list of gifts the customer created with details such as the list name, date created, products in the lists and their purchase registry.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"pattern": "^[A-Z]{2}$",
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"registryType": {
"enum": [
"WEDDING",
"BABY",
"CUSTOM",
"BIRTHDAY",
"PET",
"HOLIDAY"
],
"description": "The type of the gift list (e.g., WEDDING)."
},
"isActive": {
"type": "boolean",
"description": "The flag that indicates whether the gift list is active (e.g., true)."
},
"listEventDate": {
"type": "string",
"format": "full-date",
"description": "The date of gift list event (e.g., 2017-05-09)."
},
"eventCity": {
"type": "string",
"description": "The city location of the event (e.g., Wernigerode)."
},
"eventState": {
"type": "string",
"description": "The state location of the event (e.g., Sachsen-Anhalt)."
},
"eventCountry": {
"type": "string",
"description": "The country location of the event (e.g., Germany)."
},
"isSharedWithPartnerSite": {
"type": "boolean",
"description": "The flag that indicates whether the option to share the gift list with a partner is enabled (e.g., false)."
},
"privacy": {
"enum": [
"PUBLIC",
"PRIVATE",
"SHARED"
],
"description": "The state that indicates the visibility of the gift list (e.g., PUBLIC)."
},
"registryPurchases": {
"type": "array",
"description": "The registry of the purchases.",
"items": {
"type": "object",
"properties": {
"giftCardBalancePurchaseAmount": {
"type": "number",
"description": "The amount of a gift card that was used on the purchase amount (e.g., 0.0)."
},
"purchaseDate": {
"type": "string",
"format": "date-time",
"description": "The date of the gift list purchase, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2017-10-14T10:33:34.106Z)."
},
"isCancelled": {
"type": "boolean",
"description": "The flag that indicates whether the order was cancelled (e.g., false)."
},
"purchaseAmount": {
"type": "number",
"description": "The cost of the purchase (e.g., 64.99)."
},
"purchaseQuantity": {
"type": "number",
"description": "The quantity of the purchase (e.g., 1)."
},
"product": {
"type": "object",
"description": "The purchased product details.",
"properties": {
"productName": {
"type": "string",
"description": "The purchased product name (e.g., TV Wall Mount, JUSTSTONE TV Bracket Fits Most 26-65 Inch LED Flat & Curved TVs)."
},
"asin": {
"type": "string",
"description": "The identifier of the purchased product, a unique ten-digit alphanumeric code (e.g., B07YWSY5TG)."
}
},
"required": [
"asin"
]
}
},
"required": [
"giftCardBalancePurchaseAmount",
"purchaseDate",
"isCancelled",
"purchaseAmount",
"purchaseQuantity",
"product"
]
}
},
"vanityUrls": {
"type": "array",
"description": "The list of vanity URLs.",
"items": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean",
"description": "The flag that specifies whether the gift list is active or not (e.g., false)."
},
"url": {
"type": "string",
"description": "The vanity url (e.g., https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4)."
},
"originalUrl": {
"type": "string",
"description": "The original vanity url (e.g., https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4)."
}
},
"required": [
"isActive",
"url",
"originalUrl"
]
}
}
},
"required": [
"marketplace",
"eventDate",
"registryType",
"isActive"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"registryType": "WEDDING",
"isActive": true,
"listEventDate": "2017-05-09",
"eventCity": "Wernigerode",
"eventState": "Sachsen-Anhalt",
"eventCountry": "Germany",
"isSharedWithPartnerSite": false,
"privacy": "PUBLIC",
"registryPurchases": [
{
"giftCardBalancePurchaseAmount": 0.0,
"purchaseDate": "2017-10-14T10:33:34.106Z",
"isCancelled": false,
"purchaseAmount": 64.99,
"purchaseQuantity": 1,
"product": {
"productName": "TV Wall Mount, JUSTSTONE TV Bracket Fits Most 26-65 Inch LED Flat & Curved TVs",
"asin": "B07YWSY5TG"
}
}
],
"vanityUrls": [
{
"isActive": false,
"url": "https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4",
"originalUrl": "https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4"
}
]
}
]
Lists
This scope includes Amazon customer's occasion lists with details like name, occasion, and description.
Identifiers:
- Login with Amazon Scope Name:
portability::lists
- Amazon Data Portability
scopeId
:portability-lists
Lists
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
listAccessPolicy |
The access policy for the list. | PUBLIC |
archived |
The flag that indicates that the list is archived. | false |
babyRegistryFlags |
The baby registry flags. | N/A |
babyRegistryFlags.receiveRegistryTips |
The flag that indicates that the customer has opted to receive registry tips. | false |
babyRegistryFlags.marketingEmailsEnabled |
The flag that indicates that the customer has opted to receive marketing emails. | false |
babyRegistryFlags.claimCodeSent |
The flag that indicates that the claim code has been sent to the co-registrant. | false |
babyRegistryFlags.registerForDiaperFund |
The flag that indicates that the customer has registered their list for the diaper fund. | false |
babyRegistryFlags.giftCardOptIn |
The flag that indicates that the customer has opted in for showing gift cards on their list. | false |
babyRegistryFlags.shareWithPartnerSites |
The flag that indicates that the customer has opted to share their data with partner sites. | false |
babyRegistryFlags.listEmailsEnabled |
The flag that indicates that the customer has opted to receive list emails. | false |
babyRegistryFlags.primeOptIn |
The flag that indicates that the customer has opted in for showing Prime membership on their list. | true |
babyRegistryFlags.isFirstBaby |
The flag that indicates that this is the first baby. | false |
checklistUseCase |
The use case for which the list is created. | sport:baseball |
deleted |
The flag that indicates that the relation between the user and the list has been deleted. | false |
listDescription |
The description associated with the list. | Birthday Party |
eventSearchTag |
The tag used for filtering event registry search results. | events |
listSettings |
The set of flags based of actions the user has taken to record where users have opted-in or opted-out. | KEEP_GIFT_SURPRISE_ENABLED |
recipientGender |
The gender of the user. | FEMALE |
giftFund |
The gift fund. | N/A |
giftFund.goalAmount |
The goal amount of the gift fund. | N/A |
giftFund.goalAmount.amount |
The monetary amount. | N/A |
giftFund.goalAmount.amount.value |
The monetary amount value. | 1 |
giftFund.goalAmount.amount.currencyCode |
The currency code of the monetary amount value formatted according to ISO 4217 standard. | EUR |
giftFund.goalAmount.isHidden |
The flag that indicates whether the amount is hidden. | false |
giftFund.giftFundDescription |
The description of the gift fund. | My first gift fund |
giftFund.giftFundImageUrl |
The url to the image of the gift fund. | https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png |
giftFund.giftFundTitle |
The title of the gift fund. | Happy Birthday to Me |
interests |
The list of user's interests. | Reading |
listName |
The name associated with the list. | Birthday |
calendarDefinedOccasion |
The occasion associated with the list. | N/A |
calendarDefinedOccasion.name |
The name of the occasion. | CHRISTMAS |
calendarDefinedOccasion.startYear |
The year the occasion is created in. | 2022 |
calendarDefinedOccasion.eventLocation |
The event location where the occasion occurs. | N/A |
calendarDefinedOccasion.eventLocation.country |
The country that the event is held in. | France |
calendarDefinedOccasion.eventLocation.city |
The city that the event is held in. | Paris |
calendarDefinedOccasion.eventLocation.state |
The state that the event is held in. | Paris |
calendarDefinedOccasion.reminderPreferences |
The preferences for when reminder emails should be sent for the occasion. | N/A |
calendarDefinedOccasion.reminderPreferences.timeBefore |
The amount of time before the occasion date to send reminder emails. | 2 |
calendarDefinedOccasion.reminderPreferences.timeUnit |
The unit of time used for the amount of time before the occasion date to send reminder emails. | days |
recurrencePreferences |
The recurrence preferences. | N/A |
recurrencePreferences.recurrenceInterval |
The recurrence interval. | 3 |
recurrencePreferences.timeUnit |
The time unit for the recurrence interval. | days |
customNamedOccasion |
The custom named occasion. | N/A |
customNamedOccasion.name |
The name of the custom named occasion. | My Birthday |
customNamedOccasion.description |
The description of the custom named occasion. | Gifts for my birthday |
customNamedOccasion.month |
The month of the custom named occasion. | MAY |
customNamedOccasion.day |
The day of the custom named occasion. | 14 |
customNamedOccasion.startYear |
The year of the custom named occasion. | 2025 |
customNamedOccasion.ageStartYear |
The age at when the custom named occasion occurs. | 7 |
customNamedOccasion.eventLocation |
The event location used to describe the location of the custom named occasion. | N/A |
customNamedOccasion.eventLocation.country |
The country of the location for the custom named occasion. | France |
customNamedOccasion.eventLocation.city |
The city of the location for the custom named occasion. | Paris |
customNamedOccasion.eventLocation.state |
The state of the location for the custom named occasion. | Paris |
customNamedOccasion.reminderPreferences |
The recurrence preferences for the custom named occasion. | N/A |
customNamedOccasion.reminderPreferences.timeBefore |
The amount of time before the custom named occasion to start the reminder. | 10 |
customNamedOccasion.reminderPreferences.timeUnit |
The unit of time for the amount of time before the custom named occasion to start the reminder. | days |
customNamedOccasion.recurrencePreferences |
The recurrence preferences for the named occasion. | N/A |
customNamedOccasion.recurrencePreferences -> recurrenceInterval |
The recurrence interval for the custom named occasion. | 3 |
customNamedOccasion.recurrencePreferences.timeUnit |
The unit of time for the recurrence interval of the custom named occasion. | days |
namedOccasion |
The named occasion. | N/A |
namedOccasion.name |
The name of the named occasion. | BIRTHDAY |
namedOccasion.description |
The description of the named occasion. | Gifts for my birthday |
namedOccasion.month |
The month of the named occasion. | MAY |
namedOccasion.day |
The day of the named occasion. | 14 |
namedOccasion.startYear |
The year of the named occasion. | 2022 |
namedOccasion.ageAtStartYear |
The age at when the named occasion occurs. | 7 |
namedOccasion.eventLocation |
The event location used to describe the location of the named occasion. | N/A |
namedOccasion.eventLocation.country |
The country of the location for the named occasion. | France |
namedOccasion.eventLocation.city |
The city of the location for the named occasion. | Paris |
namedOccasion.eventLocation.state |
The state of the location for the named occasion. | Paris |
namedOccasion.reminderPreferences |
The reminder preferences for the named occasion. | N/A |
namedOccasion.reminderPreferences.timeBefore |
The amount of time before the named occasion to start the reminder. | 10 |
namedOccasion.reminderPreferences.timeUnit |
The unit of time for the amount of time before the named occasion to start the reminder. | days |
namedOccasion.recurrencePreferences |
The recurrence preferences for the named occasion. | N/A |
namedOccasion.recurrencePreferences.recurrenceInterval |
The recurrence interval for the named occasion. | 3 |
namedOccasion.recurrencePreferences.timeUnit |
The unit of time for the recurrence interval of the named occasion. | days |
organizationUrl |
The URL of the organization website. | www.maxwells-organization.org |
recipientAge |
The age range for the recipient. | N/A |
recipientAge.startAge |
The start of the age range. | 4 |
recipientAge.endAge |
The end of the age range. | 5 |
ownerRelationship |
The information about the relationship between a user and the owner of a list. | Partner |
searchTerm |
The search keywords. | N/A |
searchTerm.keyword |
The keyword that customers want to store on their list in order to find related products. | cat |
searchTerm.checkedOff |
The flag that indicates that at least one product has been added to the list based of the keyword. | false |
userRole |
The name of the role of a user in a list. | GROOM |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lists",
"description": "Includes all occasion lists defined by the customer with details such as name, occasion and description.",
"type": "array",
"items": {
"type": "object",
"properties": {
"listAccessPolicy": {
"type": "string",
"description": "The access policy for the list (e.g., PUBLIC)."
},
"archived": {
"type": "boolean",
"description": "The flag that indicates that the list is archived (e.g., false)."
},
"babyRegistryFlags": {
"type": "object",
"description": "The baby registry flags.",
"properties": {
"receiveRegistryTips": {
"type": "boolean",
"description": "The flag that indicates that the customer has opted to receive registry tips (e.g., false)."
},
"marketingEmailsEnabled": {
"type": "boolean",
"description": "The flag that indicates that the customer has opted to receive marketing emails (e.g., false)."
},
"claimCodeSent": {
"type": "boolean",
"description": "The flag that indicates that the claim code has been sent to the co-registrant (e.g., false)."
},
"registerForDiaperFund": {
"type": "boolean",
"description": "The flag that indicates that the customer has registered their list for the diaper fund (e.g., false)."
},
"giftCardOptIn": {
"type": "boolean",
"description": "The flag that indicates that the customer has opted in for showing gift cards on their list (e.g., false)."
},
"shareWithPartnerSites": {
"type": "boolean",
"description": "The flag that indicates that the customer has opted to share their data with partner sites (e.g., false)."
},
"listEmailsEnabled": {
"type": "boolean",
"description": "The flag that indicates that the customer has opted to receive list emails (e.g., false)."
},
"primeOptIn": {
"type": "boolean",
"description": "The flag that indicates that the customer has opted in for showing Prime membership on their list (e.g., true)."
},
"isFirstBaby": {
"type": "boolean",
"description": "The flag that indicates that this is the first baby (e.g., false)."
}
}
},
"checklistUseCase": {
"type": "string",
"description": "The use case for which the list is created (e.g., sport:baseball)."
},
"deleted": {
"type": "boolean",
"description": "The flag that indicates that the relation between the user and the list has been deleted (e.g., false)."
},
"listDescription": {
"type": "string",
"description": "The description associated with the list (e.g., Birthday Party)."
},
"eventSearchTag": {
"type": "string",
"description": "The tag used for filtering event registry search results (e.g., events)."
},
"listSettings": {
"type": "array",
"description": "The set of flags based of actions the user has taken to record where users have opted-in or opted-out (e.g., KEEP_GIFT_SURPRISE_ENABLED).",
"items": {
"type": "string",
"enum": [
"WISH_LIST_DISMISSED",
"SHOPPING_LIST_DISMISSED",
"AUTO_REMEMBER_DISABLED",
"AUTO_REMEMBER_EMAIL_DISABLED",
"AUTO_REMEMBER_EMAIL_SENT",
"CLAIM_CODE_SENT",
"MARKETING_EMAILS_ENABLED",
"LIST_EMAILS_ENABLED",
"VENDOR_EMAILS_ENABLED",
"SHARE_WITH_PARTNER_SITE_ENABLED",
"PLEASE_NO_GIFT_WRAP",
"BLACKOUT_FILTER_DISABLED",
"SCHOOL_LIST_POPOVER_DISPLAYED",
"REFERRED_REGISTRY_ENABLED",
"KEEP_GIFT_SURPRISE_ENABLED"
]
}
},
"recipientGender": {
"type": "string",
"description": "The gender of the user (e.g., FEMALE).",
"enum": [
"MALE",
"FEMALE",
"UNKNOWN"
]
},
"giftFund": {
"type": "object",
"description": "The gift fund.",
"properties": {
"goalAmount": {
"type": "object",
"description": "The goal amount of the gift fund.",
"properties": {
"amount": {
"type": "object",
"description": "The monetary amount.",
"properties": {
"value": {
"type": "integer",
"description": "The monetary amount value (e.g., 1).",
"minimum": 0
},
"currencyUnit": {
"type": "string",
"description": "The currency code of the monetary amount value formatted according to ISO 4217 standard (e.g., EUR)."
}
},
"required": [
"value",
"currencyUnit"
]
},
"isHidden": {
"type": "boolean",
"description": "The flag that indicates whether the amount is hidden (e.g., false)."
}
}
},
"giftFundDescription": {
"type": "string",
"description": "The description of the gift fund (e.g., My first gift fund)."
},
"giftFundImageUrl": {
"type": "string",
"description": "The url to the image of the gift fund (e.g., https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png)."
},
"giftFundTitle": {
"type": "string",
"description": "The title of the gift fund (e.g., Happy Birthday to Me)."
}
}
},
"interests": {
"type": "array",
"description": "The list of user's interests (e.g., Reading).",
"items": {
"type": "string"
}
},
"listName": {
"type": "string",
"description": "The name associated with the list (e.g., Birthday)."
},
"calendarDefinedOccasion": {
"type": "object",
"description": "The occasion associated with the list.",
"properties": {
"name": {
"type": "string",
"description": "The name of the occasion (e.g., CHRISTMAS).",
"enum": [
"ADMIN_PROFESSIONAL_DAY",
"BOSS_DAY",
"CHRISTMAS",
"EASTER",
"FATHERS_DAY",
"GRANDPARENTS_DAY",
"HALLOWEEN",
"HANUKKAH",
"INDEPENDENCE_DAY",
"KWANZAA",
"LABOR_DAY",
"MOTHERS_DAY",
"NEW_YEARS_DAY",
"PASSOVER",
"THANKSGIVING",
"VALENTINES_DAY"
]
},
"startYear": {
"type": "integer",
"description": "The year the occasion is created in (e.g., 2022)."
},
"eventLocation": {
"type": "object",
"description": "The event location where the occasion occurs.",
"properties": {
"country": {
"type": "string",
"description": "The country that the event is held in (e.g., France)."
},
"city": {
"type": "string",
"description": "The city that the event is held in (e.g., Paris)."
},
"state": {
"type": "string",
"description": "The state that the event is held in (e.g., Paris)."
}
}
},
"reminderPreferences": {
"type": "object",
"description": "The preferences for when reminder emails should be sent for the occasion.",
"properties": {
"timeBefore": {
"type": "integer",
"description": "The amount of time before the occasion date to send reminder emails (e.g., 2)."
},
"timeUnit": {
"type": "string",
"description": "The unit of time used for the amount of time before the occasion date to send reminder emails (e.g., days)."
}
},
"required": [
"timeBefore",
"timeUnit"
]
},
"recurrencePreferences": {
"type": "object",
"description": "The recurrence preferences.",
"properties": {
"recurrenceInterval": {
"type": "integer",
"description": "The recurrence interval (e.g., 3)."
},
"timeUnit": {
"type": "string",
"description": "The time unit for the recurrence interval (e.g., days)."
}
},
"required": [
"recurrenceInterval",
"timeUnit"
]
}
},
"required": [
"name"
]
},
"customNamedOccasion": {
"type": "object",
"description": "The custom named occasion.",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom named occasion (e.g., My Birthday)."
},
"description": {
"type": "string",
"description": "The description of the custom named occasion (e.g., Gift for my birthday)."
},
"month": {
"type": "string",
"description": "The month of the custom named occasion (e.g., MAY)."
},
"day": {
"type": "integer",
"description": "The day of the custom named occasion (e.g., 14)."
},
"startYear": {
"type": "integer",
"description": "The year of the custom named occasion (e.g., 2022)."
},
"ageAtStartYear": {
"type": "integer",
"description": "The age at when the custom named occasion occurs (e.g., 7)."
},
"eventLocation": {
"type": "object",
"description": "The event location used to describe the location of the custom named occasion.",
"properties": {
"country": {
"type": "string",
"description": "The country of the location for the custom named occasion (e.g., France)."
},
"city": {
"type": "string",
"description": "The city of the location for the custom named occasion (e.g., Paris)."
},
"state": {
"type": "string",
"description": "The state of the location for the custom named occasion (e.g., Paris)."
}
}
},
"reminderPreferences": {
"type": "object",
"description": "The recurrence preferences for the custom named occasion.",
"properties": {
"timeBefore": {
"type": "integer",
"description": "The amount of time before the custom named occasion to start the reminder (e.g., 10)."
},
"timeUnit": {
"type": "string",
"description": "The unit of time for the amount of time before the custom named occasion to start the reminder (e.g., days)."
}
},
"required": [
"timeBefore",
"timeUnit"
]
},
"recurrencePreferences": {
"type": "object",
"description": "The recurrence preferences for the named occasion.",
"properties": {
"recurrenceInterval": {
"type": "integer",
"description": "The recurrence interval for the custom named occasion (e.g., 3)."
},
"timeUnit": {
"type": "string",
"description": "The unit of time for the recurrence interval of the custom named occasion (e.g., days)."
}
},
"required": [
"recurrenceInterval",
"timeUnit"
]
}
},
"required": [
"name"
]
},
"namedOccasion": {
"type": "object",
"description": "The named occasion.",
"properties": {
"name": {
"type": "string",
"description": "The name of the named occasion (e.g., BIRTHDAY).",
"enum": [
"ANNIVERSARY",
"BABY_SHOWER",
"BIRTHDAY",
"WISHLIST_BIRTHDAY",
"BRIDAL_SHOWER",
"CONGRATULATIONS",
"GRADUATION",
"HOUSE_WARMING",
"MAZEL_TOV",
"WEDDING",
"CUSTOM",
"HOLIDAY",
"PET"
]
},
"description": {
"type": "string",
"description": "The description of the named occasion (e.g., Gifts for my birthday)."
},
"month": {
"type": "string",
"description": "The month of the named occasion (e.g., MAY)."
},
"day": {
"type": "integer",
"description": "The day of the named occasion (e.g., 14)."
},
"startYear": {
"type": "integer",
"description": "The year of the named occasion (e.g., 2022)."
},
"ageAtStartYear": {
"type": "integer",
"description": "The age at when the named occasion occurs (e.g., 7)."
},
"eventLocation": {
"type": "object",
"description": "The event location used to describe the location of the named occasion.",
"properties": {
"country": {
"type": "string",
"description": "The country of the location for the named occasion (e.g., France)."
},
"city": {
"type": "string",
"description": "The city of the location for the named occasion (e.g., Paris)."
},
"state": {
"type": "string",
"description": "The state of the location for the named occasion (e.g., Paris)."
}
}
},
"reminderPreferences": {
"type": "object",
"description": "The reminder preferences for the named occasion.",
"properties": {
"timeBefore": {
"type": "integer",
"description": "The amount of time before the named occasion to start the reminder (e.g., 10)."
},
"timeUnit": {
"type": "string",
"description": "The unit of time for the amount of time before the named occasion to start the reminder (e.g., days)."
}
},
"required": [
"timeBefore",
"timeUnit"
]
},
"recurrencePreferences": {
"type": "object",
"description": "The recurrence preferences for the named occasion.",
"properties": {
"recurrenceInterval": {
"type": "integer",
"description": "The recurrence interval for the named occasion (e.g., 3)."
},
"timeUnit": {
"type": "string",
"description": "The unit of time for the recurrence interval of the named occasion (e.g., days)."
}
},
"required": [
"recurrenceInterval",
"timeUnit"
]
}
},
"required": [
"name"
]
},
"organizationUrl": {
"type": "string",
"description": "The URL of the organization website (e.g., www.maxwells-organization.org)."
},
"recipientAge": {
"type": "object",
"description": "The age range for the recipient.",
"properties": {
"startAge": {
"type": "integer",
"description": "The start of the age range (e.g., 4)."
},
"endAge": {
"type": "integer",
"description": "The end of the age range (e.g., 5)."
}
},
"required": [
"startAge",
"endAge"
]
},
"ownerRelationship": {
"type": "string",
"description": "The information about the relationship between a user and the owner of a list (e.g., Partner)."
},
"searchTerm": {
"type": "object",
"description": "The search keywords.",
"properties": {
"keyword": {
"type": "string",
"pattern": "\\s*\\S+.*",
"description": "The keyword that customers want to store on their list in order to find related products (e.g., cat)."
},
"checkedOff": {
"type": "boolean",
"description": "The flag that indicates that at least one product has been added to the list based of the keyword (e.g., false)."
}
},
"required": [
"keyword",
"checkedOff"
],
"unevaluatedProperties": false
},
"userRole": {
"type": "string",
"description": "The name of the role of a user in a list (e.g., GROOM)."
},
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
}
},
"required": [
"marketplace",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"listAccessPolicy": "PUBLIC",
"archived": false,
"babyRegistryFlags": {
"receiveRegistryTips": false,
"marketingEmailsEnabled": false,
"claimCodeSent": false,
"registerForDiaperFund": false,
"giftCardOptIn": false,
"shareWithPartnerSites": false,
"listEmailsEnabled": false,
"primeOptIn": true,
"isFirstBaby": false
},
"checklistUseCase": "sport:baseball",
"deleted": false,
"listDescription": "Birthday Party",
"eventSearchTag": "events",
"listSettings": [
"KEEP_GIFT_SURPRISE_ENABLED"
],
"recipientGender": "FEMALE",
"giftFund": {
"goalAmount": {
"value": 1,
"currencyUnit": "EUR"
},
"isHidden": false,
"giftFundDescription": "My first gift fund",
"giftFundImageUrl": "https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png",
"giftFundTitle": "Happy Birthday to Me"
},
"interests": [
"Reading"
],
"listName": "Birthday",
"calendarDefinedOccasion": {
"name": "CHRISTMAS",
"startYear": 2022,
"eventLocation": {
"country": "France",
"city": "Paris",
"state": "Paris"
},
"reminderPreferences": {
"type": "object",
"timeBefore": 2,
"timeUnit": "days"
},
"recurrencePreferences": {
"recurrenceInterval": 3,
"timeUnit": "days"
}
},
"customNamedOccasion": {
"name": "My Birthday",
"description": "Gift for my birthday",
"month": "MAY",
"day": 14,
"startYear": 2022,
"ageAtStartYear": 7,
"eventLocation": {
"country": "France",
"city": "Paris",
"state": "Paris"
},
"reminderPreferences": {
"timeBefore": 10,
"timeUnit": "days"
},
"recurrencePreferences": {
"recurrenceInterval": 3,
"timeUnit": "days"
}
},
"namedOccasion": {
"name": "BIRTHDAY",
"description": "Gifts for my birthday",
"month": "MAY",
"day": 14,
"startYear": 2022,
"ageAtStartYear": 7,
"eventLocation": {
"country": "France",
"city": "Paris",
"state": "Paris"
},
"reminderPreferences": {
"timeBefore": 10,
"timeUnit": "days"
},
"recurrencePreferences": {
"recurrenceInterval": 3,
"timeUnit": "days"
}
},
"organizationUrl": "www.maxwells-organization.org",
"recipientAge": {
"startAge": 4,
"endAge": 5
},
"ownerRelationship": "Partner",
"searchTerm": {
"keyword": "cat",
"checkedOff": false
},
"userRole": "GROOM"
}
]
Physical order returns
This scope includes Amazon customer's physical order returns history with details like product refund amounts and their dates.
Identifiers:
- Login with Amazon Scope Name:
portability::physical_order_returns
- Amazon Data Portability
scopeId
:portability-physical-order-returns
Physical order return payments
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
orderId |
The unique identifier for the order which the return/reversal corresponds. | 403-9139873-1268352 |
amountRefunded |
The amount of money refunded to the customer (23.45). | 23.45 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Physical Orders - Return Payments",
"description": "Includes the list of payments for the customer's physical order returns.",
"type": "array",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"pattern": "^[A-Z]{2}$"
},
"orderId": {
"type": "string",
"description": "The unique identifier for the order which the return/reversal corresponds."
},
"amountRefunded": {
"type": "string",
"description": "The amount of money refunded to the customer (23.45)."
}
},
"unevaluatedProperties": false,
"required": [
"marketplace",
"eventDate"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"orderId": "403-9139873-1268352",
"amountRefunded": "23.45"
}
]
Physical order returns
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
creationDate |
The date when the return was initiated, in the ISO 8601 date-time format and UTC time zone. | 2023-11-28T11:55:29.540Z |
orderId |
The unique identifier for the order which the return corresponds. | 403-9139873-1268352 |
currencyCode |
The currency code for the pricing data, formatted according to ISO 4217 standard. | EUR |
quantity |
The number of units being returned of the product. | 1 |
reversalReason |
The reason chosen by the to initiate the return process. | customer return |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Physical Orders - Returns",
"description": "Includes the list of customer's physical order returns.",
"type": "array",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"creationDate": {
"type": "string",
"format": "date-time",
"description": "The date when the return was initiated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"pattern": "^[A-Z]{2}$"
},
"orderId": {
"type": "string",
"description": "The unique identifier for the order which the return corresponds (e.g., 403-9139873-1268352)."
},
"currencyCode": {
"type": "string",
"description": "The currency code for the pricing data, formatted according to ISO 4217 standard (e.g., EUR)."
},
"quantity": {
"type": "integer",
"description": "The number of units being returned of the product (1)."
},
"reversalReason": {
"type": "string",
"description": "The reason chosen by the to initiate the return process (e.g., customer return)."
}
},
"unevaluatedProperties": false,
"required": [
"marketplace",
"eventDate",
"creationDate"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"creationDate": "2021-09-29T11:04:43.305Z",
"orderId": "403-9139873-1268352",
"currencyCode": "EUR",
"quantity": 1,
"reversalReason": "customer return"
}
]
Physical orders
This scope includes Amazon customer's physical order history with details like product names, quantity, and prices paid.
Identifiers:
- Login with Amazon Scope Name:
portability::physical_orders
- Amazon Data Portability
scopeId
:portability-physical-orders
Physical orders
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
productName |
The title of the product as displayed on the Amazon Retail Website product page. | Amazon Fire HD 10 tablet, 1080p Full HD, 32 GB, latest model (2021 release), Lavender |
website |
The domain of the Amazon Retail Website where the order was placed. | Amazon.fr , Amazon.it , Amazon.de |
orderId |
The unique identifier for an order which the product belongs to. | 701-7195934-7003458 |
orderDate |
The date when the customer placed the order, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2023-04-11T08:26:22Z |
currencyCode |
The currency code for the price, formatted according to ISO 4217 standard. | EUR |
quantity |
The quantity of the product. | 1 |
productCondition |
The condition of the product, whether it is used or new. | New , Used |
totalOwed |
The total price of the order including all charges and discounts. | 21.39 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Physical Orders",
"description": "Includes account's physical orders history, like product names, quantity and prices paid.",
"type": "array",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"orderDate": {
"type": "string",
"format": "date-time",
"description": "The date when the customer placed the order, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"pattern": "^[A-Z]{2}$"
},
"productName": {
"type": "string",
"description": "The title of the product as displayed on the Amazon Retail Website product page (e.g., Amazon Fire HD 10 tablet, 1080p Full HD, 32 GB, Lavender)."
},
"website": {
"type": "string",
"description": "The domain of the Amazon Retail Website where the order was placed (e.g., Amazon.fr, Amazon.de, Amazon.com.be, etc.)."
},
"orderId": {
"type": "string",
"description": "The unique identifier for an order which the product belongs to (e.g., 701-7195934-7003458)."
},
"currencyCode": {
"type": "string",
"description": "The currency code for the price, formatted according to ISO 4217 standard (e.g., EUR, GBP, etc.)."
},
"quantity": {
"type": "integer",
"description": "The quantity of the product (e.g., 5)."
},
"productCondition": {
"type": "string",
"description": "The condition of the product, whether it is used or new (e.g., New, Used)."
},
"totalOwed": {
"type": "number",
"description": "The total price of the order including all charges and discounts (e.g., 21.39)."
}
},
"unevaluatedProperties": false,
"required": [
"marketplace",
"eventDate",
"orderDate"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "FR",
"eventDate": "2021-09-29T11:04:43.305Z",
"orderDate": "2021-02-08T11:04:43.305Z",
"productName": "Amazon Fire HD 10 tablet, 1080p Full HD, 32 GB, latest model (2021 release), Lavender",
"website": "Amazon.fr",
"orderId": "701-7195934-7003458",
"currencyCode": "EUR",
"quantity": 1,
"productCondition": "New",
"totalOwed": 21.39
}
]
Physical product subscriptions
This scope includes Amazon customer's list of physical product subscriptions with details like quantity of the subscribed items, their frequency, and alternate products if subscribed items are unavailable.
Identifiers:
- Login with Amazon Scope Name:
portability::physical_subscriptions
- Amazon Data Portability
scopeId
:portability-physical-subscriptions
Physical product subscriptions
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
website |
The friendly name of the marketplace where the subscription was created. | Amazon.de |
productTitle |
The product title of the subscribed item. | Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 1 Cube Box, 60 Tissues per Box |
frequency |
The frequency interval of the subscription. | 2 MONTH |
quantity |
The quantity of subscribed items. | 2 |
subscriptionState |
The current status of the subscription. | ACTIVE |
statusChangeDate |
The date when subscription state changed, in the ISO 8601 date-time format and UTC time zone. | 2021-09-29T11:04:43.305Z |
merchant |
The merchant identifier for the subscribed item. | Amazon.de |
backupProductTitle |
The backup product title of the subscribed item. | Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 4 Flat Boxes, 120 Tissues per Box |
backupMerchant |
The backup merchant identifier of the subscribed item. | Amazon.de |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Physical Product Subscriptions",
"description": "Includes the list of customers' physical product subscriptions, with details such as quantity of the subscribed items, their frequency or alternate products if subscribed items are unavailable.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string"
},
"website": {
"type": "string",
"description": "The friendly name of the marketplace where the subscription was created (e.g., Amazon.de)."
},
"productTitle": {
"description": "The product title of the subscribed item (e.g., Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 1 Cube Box, 60 Tissues per Box).",
"type": "string"
},
"frequency": {
"description": "The frequency interval of the subscription (e.g., 2 MONTH).",
"type": "string"
},
"quantity": {
"description": "The quantity of subscribed items (e.g., 2).",
"type": "number"
},
"subscriptionState": {
"description": "The current status of the subscription (e.g., ACTIVE).",
"type": "string",
"enum": [
"ACTIVE",
"CANCELED",
"INACTIVE",
"STOPPED",
"DELETED"
]
},
"statusChangeDate": {
"type": "string",
"format": "date-time",
"description": "The date when subscription state changed, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"merchant": {
"description": "The merchant identifier for the subscribed item (e.g., Amazon.de).",
"type": "string"
},
"backupProductTitle": {
"description": "The backup product title of the subscribed item (e.g., Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 4 Flat Boxes, 120 Tissues per Box).",
"type": "string"
},
"backupMerchant": {
"description": "The backup merchant identifier of the subscribed item (e.g., Amazon.de).",
"type": "string"
}
},
"required": [
"marketplace",
"eventDate",
"productTitle"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"website": "Amazon.de",
"productTitle": "Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 1 Cube Box, 60 Tissues per Box",
"frequency": "2 MONTH",
"quantity": 2,
"subscriptionState": "ACTIVE",
"statusChangeDate": "2021-09-29T11:04:43.305Z",
"merchant": "Amazon.de",
"backupProductTitle": "Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 4 Flat Boxes, 120 Tissues per Box",
"backupMerchant": "Amazon.de"
}
]
Product substitution preferences
This scope includes Amazon customer's list of products that can be substituted by other products and their preferred substitute product.
Identifiers:
- Login with Amazon Scope Name:
portability::substitution_preferences
- Amazon Data Portability
scopeId
:portability-substitution-preferences
Product substitution preferences
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
asin |
The identifier of the product for which substitution preferences were configured, a unique ten-digit alphanumeric code. | B0CJ3J2WCR |
productName |
The title of the product for which substitution preferences were configured. | Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 1 Cube Box, 60 Tissues per Box |
replacementAsin |
The identifier of the product selected as a preferred substitution, a unique ten-digit alphanumeric code. | B08PDRXH59 |
replacementProductName |
The title of the product selected as a preferred substitution. | Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 4 Flat Boxes, 120 Tissues per Box |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Product Substitution Preferences",
"description": "Includes the list of products that can be substituted by other products and their preferred substitute product.",
"type": "array",
"items": {
"type": "object",
"properties": {
"marketplace": {
"pattern": "^[A-Z]{2}$",
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"asin": {
"type": "string",
"description": "The identifier of the product for which substitution preferences were configured, a unique ten-digit alphanumeric code (e.g., B0CJ3J2WCR)."
},
"productName": {
"type": "string",
"description": "The title of the product for which substitution preferences were configured (e.g., Kleenex Soothing Lotion Facial Tissues with Coconut Oil, Aloe & Vitamin E, 1 Cube Box, 60 Tissues per Box)."
},
"replacementAsin": {
"type": "string",
"description": "The identifier of the product selected as a preferred substitution, a unique ten-digit alphanumeric code (e.g., B08PDRXH59)."
},
"replacementProductName": {
"type": "string",
"description": "The title of the product selected as a preferred substitution (e.g., Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 4 Flat Boxes, 120 Tissues per Box)."
}
},
"unevaluatedProperties": false,
"required": [
"marketplace",
"eventDate",
"asin",
"productName",
"replacementAsin",
"replacementProductName"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"asin": "B0CJ3J2WCR",
"productName": "Kleenex Soothing Lotion Facial Tissues with Coconut Oil, Aloe & Vitamin E, 1 Cube Box, 60 Tissues per Box",
"replacementAsin": "B08PDRXH59",
"replacementProductName": "Kleenex Soothing Lotion Facial Tissues with Coconut Oil, 4 Flat Boxes, 120 Tissues per Box"
}
]
Search history
This scope includes Amazon customer's search queries and details like the device and application used to initiate the search, and also the list of search result product identifiers that were clicked by the customer or added to their shopping basket.
Identifiers:
- Login with Amazon Scope Name:
portability::search_insights
- Amazon Data Portability
scopeId
:portability-search-insights
Search history products
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
clickedAsins |
The comma delimited list of unique product identifiers that were clicked as a result of this impression. | B0CJ3J2WCR,B08PDRXH59 |
addedAsins |
The comma delimited list of unique product identifiers that were added as a result of this impression. | B0873YHGDW,B0873YHGDW |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Search History - Products",
"description": "Includes the list of search result products that were clicked or added to the cart by the customer.",
"type": "array",
"items": {
"type": "object",
"required": [
"marketplace",
"eventDate"
],
"unevaluatedProperties": false,
"properties": {
"marketplace": {
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"type": "string"
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"clickedAsins": {
"description": "The comma delimited list of unique product identifiers that were clicked as a result of this impression (e.g., B0CJ3J2WCR, B08PDRXH59).",
"type": "string"
},
"addedAsins": {
"description": "The comma delimited list of unique product identifiers that were added as a result of this impression (e.g., B0873YHGDW,B0873YHGDW).",
"type": "string"
}
}
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"clickedAsins": "B0CJ3J2WCR, B08PDRXH59",
"addedAsins": "B0873YHGDW,B0873YHGDW"
}
]
Search history queries
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
applicationName |
The name of the client-side application initiating the request. | Prime Video |
operatingSystemName |
The name of the OS on the client initiating the request. | blast |
operatingSystemVersion |
The version of the OS on the client initiating the request. | 13.0 |
deviceName |
The name of the device making the request. | Generic Smart TV |
keywords |
The full text entered in the keyword search box, or empty string if no keywords were entered. | bipolar |
server |
The name of server. | www.amazon.de |
aliases |
The list of search alias used in the query group. | instant-video |
firstSearchDomain |
The domain of the first search of the query group. | www.google.com |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Search History - Queries",
"description": "Includes the search queries initiated by the customer, including details such as the device and application used to initiate the search.",
"type": "array",
"items": {
"type": "object",
"required": [
"marketplace",
"eventDate"
],
"unevaluatedProperties": false,
"properties": {
"marketplace": {
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"type": "string"
},
"eventDate": {
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"applicationName": {
"description": "The name of the client-side application initiating the request (e.g., Prime Video).",
"type": "string"
},
"operatingSystemName": {
"description": "The name of the OS on the client initiating the request (e.g., blast).",
"type": "string"
},
"operatingSystemVersion": {
"description": "The version of the OS on the client initiating the request (e.g., 13.0).",
"type": "string"
},
"deviceName": {
"description": "The name of the device making the request (e.g., Generic Smart TV).",
"type": "string"
},
"keywords": {
"description": "The full text entered in the keyword search box, or empty string if no keywords were entered (e.g., bipolar).",
"type": "string"
},
"server": {
"description": "The name of server (e.g., www.amazon.de).",
"type": "string"
},
"aliases": {
"description": "The list of search alias used in the query group (e.g., instant-video).",
"type": "string"
},
"firstSearchDomain": {
"description": "The domain of the first search of the query group (e.g., www.google.com).",
"type": "string"
}
}
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"applicationName": "Prime Video",
"operatingSystemName": "blast",
"operatingSystemVersion": "13.0",
"deviceName": "Generic Smart TV",
"keywords": "bipolar",
"server": "www.amazon.de",
"aliases": "instant-video",
"firstSearchDomain": "www.google.com"
}
]
Shopping basket
This scope includes Amazon customer's products added to their shopping basket with details like their quantity and the date when they were added.
Identifiers:
- Login with Amazon Scope Name:
portability::orders_cart
- Amazon Data Portability
scopeId
:portability-orders-cart
Shopping basket
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
dateAddedToCart |
The date when the record was added to cart, in the ISO 8601 date-time format and UTC time zone. | 2021-09-29T11:04:43.305Z |
asin |
The identifier of the purchased product, a unique ten-digit alphanumeric code. | B008RLDGLO |
cartList |
The state indicating if the item is in the customer's cart, and will be included in the order when the customer proceeds to checkout. | active |
quantity |
The quantity of the item added in the cart. | 5 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Basket",
"description": "Includes products added to the customer's shopping basket with details such as their quantity or the date they were added.",
"type": "array",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was added to cart, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"dateAddedToCart": {
"type": "string",
"format": "date-time",
"description": "The date when the record was added to cart, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"marketplace": {
"type": "string",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
"pattern": "^[A-Z]{2}$"
},
"asin": {
"type": "string",
"description": "The identifier of the purchased product, a unique ten-digit alphanumeric code (e.g., B008RLDGLO)."
},
"cartList": {
"type": "string",
"description": "The state indicating if the item is in the customer's cart, and will be included in the order when the customer proceeds to checkout (e.g., active)."
},
"quantity": {
"type": "integer",
"description": "The quantity of the item added in the cart (e.g., 5)."
}
},
"unevaluatedProperties": false,
"required": [
"marketplace",
"eventDate",
"dateAddedToCart"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"dateAddedToCart": "2021-09-29T11:04:43.305Z",
"asin": "B008RLDGLO",
"cartList": "active",
"quantity": 1
}
]
Shopping profile preferences
This scope includes Amazon customer's shopping preferences with regard to details like beauty products, apparel style, fit, and sustainability.
Identifiers:
- Login with Amazon Scope Name:
portability::shopping_preferences
- Amazon Data Portability
scopeId
:portability-shopping-preferences
Shopping preferences - beauty
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
skinTypes |
The skin types. | N/A |
skinTypes.category |
The category of the skin type. | face |
skinTypes.response |
The value of the skin type. | dry |
skinConcerns |
The skin concerns. | N/A |
skinConcerns.category |
The category of the skin concern. | eyes |
skinConcerns.response |
The value of the skin concern. | hydration |
skinAge |
The age of skin in bands of 10. | 30-39 |
skinTone |
The tone of the skin. | fair |
skinCharacteristics |
The skin characteristics. | N/A |
skinCharacteristics.category |
The category of the skin characteristic. | sensitive |
skinCharacteristics.response |
The value of the skin characteristic. | yes |
productPreferences |
The beauty product preferences. | N/A |
productPreferences.category |
The category of the product preference. | general |
productPreferences.response |
The value of the product preference. | organic |
preferredDepartments |
The preferred department for shopping for beauty products. | N/A |
preferredDepartments.category |
The category of the preferred department. | general |
preferredDepartments.response |
The value of the preferred department. | womens |
preferenceFrequencies |
The frequency of collecting beauty preferences. | N/A |
preferenceFrequencies.category |
The category of the preference frequency. | premium |
preferenceFrequencies.response |
The value of the preference frequency. | always |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Beauty",
"description": "Includes beauty shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"skinTypes",
"eventDate"
]
},
{
"required": [
"skinConcerns",
"eventDate"
]
},
{
"required": [
"skinAge",
"eventDate"
]
},
{
"required": [
"skinTone",
"eventDate"
]
},
{
"required": [
"skinCharacteristics",
"eventDate"
]
},
{
"required": [
"productPreferences",
"eventDate"
]
},
{
"required": [
"preferredDepartments",
"eventDate"
]
},
{
"required": [
"preferenceFrequencies",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"skinTypes": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The skin types.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"type": "string",
"description": "The category of the skin type (e.g., face).",
"enum": [
"face"
]
},
"response": {
"type": "string",
"description": "The value of the skin type (e.g., dry).",
"enum": [
"oily",
"normal",
"combination",
"dry",
"No_Response"
]
}
}
}
},
"skinConcerns": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The skin concerns.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"type": "string",
"description": "The category of the skin concern (e.g., eyes).",
"enum": [
"top",
"general",
"eyes"
]
},
"response": {
"type": "array",
"description": "The value of the skin concern (e.g., hydration).",
"uniqueItems": true,
"minItems": 1,
"contains": {
"type": "string",
"enum": [
"fine_lines",
"anti-aging",
"acne",
"wrinkles",
"dark_circles",
"dull_skin",
"dark_spots",
"pore_size",
"age_spots",
"redness",
"hydration",
"roughness",
"sagging",
"puffiness",
"dryness",
"bags",
"brightening",
"pigmentation",
"No_Response"
]
}
}
}
}
},
"skinAge": {
"type": "array",
"description": "The age of skin in bands of 10 (e.g., 30-39).",
"uniqueItems": true,
"minItems": 1,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"under_20",
"20-29",
"30-39",
"40-49",
"50-59",
"60-and-above",
"No_Response"
]
}
},
"skinTone": {
"type": "array",
"description": "The tone of the skin (e.g., fair).",
"uniqueItems": true,
"minItems": 1,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"very_fair",
"fair",
"medium",
"medium_dark",
"dark",
"very_dark",
"No_Response"
]
}
},
"skinCharacteristics": {
"type": "array",
"description": "The skin characteristics.",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"description": "The category of the skin characteristic (e.g., sensitive).",
"type": "string",
"enum": [
"sensitive"
]
},
"response": {
"description": "The value of the skin characteristic (e.g., yes).",
"type": "string",
"enum": [
"yes",
"no",
"No_Response"
]
}
}
}
},
"productPreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The beauty product preferences.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"description": "The category of the product preference (e.g., general).",
"type": "string",
"enum": [
"free-of",
"general"
]
},
"response": {
"description": "The value of the product preference (e.g., organic).",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"contains": {
"type": "string",
"enum": [
"no-artificial-colors",
"natural",
"organic",
"vegan",
"sustainable",
"fragrance-free",
"hypoallergenic",
"paraben-free",
"cruelty-free",
"oil-free",
"alcohol-free",
"phthalate-free",
"sulfate-free",
"gluten-free",
"mineral-oil-free",
"silicone-free",
"surfactant-free",
"uv-absorber-free",
"allergy-tested",
"no-comedogenic",
"made-in-country",
"ayurvedic",
"No_Response"
]
}
}
}
}
},
"preferredDepartments": {
"type": "array",
"description": "The preferred department for shopping for beauty products.",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"description": "The category of the preferred department (e.g., general).",
"type": "string",
"enum": [
"general"
]
},
"response": {
"description": "The value of the preferred department (e.g., womens).",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
}
}
}
}
},
"preferenceFrequencies": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The frequency of collecting beauty preferences.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"description": "The category of the preference frequency (e.g., premium).",
"type": "string",
"enum": [
"premium"
]
},
"response": {
"description": "The value of the preference frequency (e.g., always).",
"type": "string",
"enum": [
"always",
"often",
"sometimes",
"rarely",
"never",
"No_Response"
]
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"skinTypes": [
{
"category": "face",
"response": "dry"
}
]
}
Shopping preferences - profile
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
gender |
The gender. | male |
height |
The height. | N/A |
height.length |
The height value. | 160 |
height.unit |
The height unit. | cm |
weight |
The weight. | N/A |
weight.mass |
The weight value. | 50 |
weight.unit |
The weight unit. | kg |
weightUnitSystem |
The unit system that customers prefer for storing weight. | imperial |
heightUnitSystem |
The unit system that customers prefer for storing height. | imperial |
unitSystem |
The unit system that customers prefer for storing height. | imperial |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Profile",
"description": "Includes profile shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"gender",
"eventDate"
]
},
{
"required": [
"height",
"eventDate"
]
},
{
"required": [
"weight",
"eventDate"
]
},
{
"required": [
"weightUnitSystem",
"eventDate"
]
},
{
"required": [
"heightUnitSystem",
"eventDate"
]
},
{
"required": [
"unitSystem",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"gender": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"description": "The gender (e.g., male).",
"items": {
"type": "string",
"enum": [
"male",
"female"
]
}
},
"height": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 1,
"description": "The height.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"length",
"unit"
],
"properties": {
"length": {
"description": "The height value (e.g., 160).",
"type": "number",
"minimum": 0
},
"unit": {
"description": "The height unit (e.g., cm).",
"type": "string",
"enum": [
"cm",
"in"
]
}
}
}
},
"weight": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 1,
"description": "The weight.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"mass",
"unit"
],
"properties": {
"mass": {
"description": "The weight value (e.g., 50).",
"type": "number",
"minimum": 0
},
"unit": {
"description": "The weight unit (e.g., kg).",
"type": "string",
"enum": [
"kg"
]
}
}
}
},
"weightUnitSystem": {
"type": "array",
"description": "The unit system that customers prefer for storing weight (e.g., imperial).",
"items": {
"type": "string",
"enum": [
"imperial",
"metric"
]
}
},
"heightUnitSystem": {
"type": "array",
"description": "The unit system that customers prefer for storing height (e.g., imperial).",
"items": {
"type": "string",
"enum": [
"imperial",
"metric"
]
}
},
"unitSystem": {
"type": "array",
"description": "The unit system that customers prefer for storing height (e.g., imperial).",
"items": {
"type": "string",
"enum": [
"imperial",
"metric"
]
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"gender": [
"male"
],
"height": [
{
"length": 120,
"unit": "cm"
}
],
"weight": [
{
"mass": 50,
"unit": "kg"
}
],
"weightUnitSystem": [
"imperial"
],
"heightUnitSystem": [
"imperial"
],
"unitSystem": [
"imperial"
]
}
Shopping preferences - apparel style
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
styleAesthetics |
The style aesthetics preferences. | N/A |
styleAesthetics.department |
The department of the style aesthetics. | mens |
styleAesthetics.category |
The category of the style aesthetics. | sporty |
styleAesthetics.response |
The value of the style aesthetics. | often |
categoryFrequency |
The frequency in which customer likes to shop in different ptd groups. | N/A |
categoryFrequency.department |
The department of the category frequency. | womens |
categoryFrequency.category |
The category of the category frequency. | skirts |
categoryFrequency.response |
The value of the category frequency. | often |
patternsPreferences |
The preferred apparel patterns. | N/A |
patternsPreferences.department |
The department of the pattern preferences. | womens |
patternsPreferences.category |
The category of the pattern preferences. | preferred-patterns |
patternsPreferences.response |
The value of the pattern preferences. | floral |
colorsPreferences |
The preferred apparel colors. | N/A |
colorsPreferences.department |
The department of the color preference. | mens |
colorsPreferences.category |
The category of the color preference. | preferred-colors |
colorsPreferences.response |
The value of the color preference. | red |
preferredShoppingDepartments |
The preferred shopping departments. | mens |
trendsInterests |
The preferred trend interests. | N/A |
trendsInterests.department |
The department of the trend interest. | womens |
trendsInterests.category |
The category of the trend interest. | seasonal-new-trends |
trendsInterests.response |
The value of the trend interest. | somewhat-interested |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Apparel Style",
"description": "Includes the apparel style shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"styleAesthetics",
"eventDate"
]
},
{
"required": [
"categoryFrequency",
"eventDate"
]
},
{
"required": [
"patternsPreferences",
"eventDate"
]
},
{
"required": [
"colorsPreferences",
"eventDate"
]
},
{
"required": [
"preferredShoppingDepartments",
"eventDate"
]
},
{
"required": [
"trendsInterests",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"styleAesthetics": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The style aesthetics preferences.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The department of the style aesthetics (e.g., mens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the style aesthetics (e.g., sporty).",
"type": "string",
"enum": [
"casual",
"edgy",
"classic",
"romantic",
"sporty",
"glam",
"minimal",
"boho",
"androgynous",
"retro",
"active",
"business-casual",
"everyday-comfort",
"outdoor-casual",
"No_Response"
]
},
"response": {
"description": "The value of the style aesthetics (e.g., often).",
"type": "string",
"enum": [
"always",
"often",
"sometimes",
"rarely",
"never",
"No_Response"
]
}
}
}
},
"categoryFrequency": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The frequency in which customer likes to shop in different ptd groups.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The department of the category frequency (e.g., womens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the category frequency (e.g., skirts).",
"type": "string",
"enum": [
"dresses",
"skirts",
"jeans",
"pants",
"shorts",
"leggings",
"button-down-shirts"
]
},
"response": {
"description": "The value of the category frequency (e.g., often).",
"type": "string",
"enum": [
"always",
"often",
"sometimes",
"rarely",
"never",
"No_Response"
]
}
}
}
},
"patternsPreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The preferred apparel patterns.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The department of the pattern preferences (e.g., womens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the pattern preferences (e.g., preferred-patterns).",
"type": "string",
"enum": [
"preferred-patterns",
"avoid-patterns"
]
},
"response": {
"description": "The value of the pattern preferences (e.g., floral).",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"contains": {
"type": "string",
"enum": [
"animal",
"floral",
"geometric",
"graphic",
"plaid",
"polkadot",
"stripes",
"tiedye",
"microfloral",
"bold-florals",
"check",
"logos",
"horizontal-stripes",
"vertical-stripes",
"critters",
"novelty",
"No_Response"
]
}
}
}
}
},
"colorsPreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The preferred apparel colors.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The department of the color preference (e.g., mens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the color preference (e.g., preferred-colors).",
"type": "string",
"enum": [
"preferred-colors",
"avoid-colors"
]
},
"response": {
"description": "The value of the color preference (e.g., red).",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"contains": {
"type": "string",
"enum": [
"blacks",
"blues",
"browns",
"gold",
"gray",
"green",
"multi",
"neutral",
"orange",
"pink",
"purple",
"red",
"silver",
"yellow",
"navy",
"light-blue",
"No_Response"
]
}
}
}
}
},
"preferredShoppingDepartments": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The preferred shopping departments (e.g., mens).",
"items": {
"type": "array",
"additionalProperties": false,
"contains": {
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
}
}
},
"trendsInterests": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The preferred trend interests.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The department of the trend interest (e.g., womens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the trend interest (e.g., seasonal-new-trends).",
"type": "string",
"enum": [
"seasonal-new-trends"
]
},
"response": {
"description": "The value of the trend interest (e.g., somewhat-interested).",
"type": "string",
"enum": [
"very-interested",
"somewhat-interested",
"not-interested",
"No_Response"
]
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"styleAesthetics": [
{
"department": "mens",
"category": "sporty",
"response": "often"
}
],
"categoryFrequency": [
{
"department": "womens",
"category": "skirts",
"response": "often"
}
],
"patternsPreferences": [
{
"department": "womens",
"category": "preferred-patterns",
"response": [
"floral"
]
}
],
"colorsPreferences": [
{
"department": "mens",
"category": "preferred-colors",
"response": [
"red"
]
}
],
"preferredShoppingDepartments": [
[
"mens"
]
],
"trendsInterests": [
{
"department": "womens",
"category": "seasonal-new-trends",
"response": "somewhat-interested"
}
]
}
Shopping preferences - shoes apparel size
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
sizePreferences |
The shoes and apparel size preferences. | N/A |
sizePreferences.department |
The department of the size preference. | womens |
sizePreferences.category |
The category of the size preference. | shoes |
sizePreferences.sizeScheme |
The size scheme of the size preference. | US |
sizePreferences.sizeNumeric |
The size numeric of the size preference. | 9 |
sizePreferences.sizeAlphanumeric |
The size alphanumeric of the size preference. | x-large |
sizePreferences.normalizedSize |
The normalized size of the size preference. | N/A |
sizePreferences.normalizedSize.size |
The normalized size value of the size preference. | 5 |
sizePreferences.normalizedSize.dimensionType |
The normalized size dimension type of the size preference. | primary |
sizePreferences.modifier |
The modifier of the size preference. | wide |
sizePreferences.brand |
The brand of the size preference. | gap |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Shoes Apparel Size",
"description": "Includes the shoes apparel size shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"sizePreferences"
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"sizePreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The shoes and apparel size preferences.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"sizeScheme"
],
"properties": {
"department": {
"description": "The department of the size preference (e.g., womens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the size preference (e.g., shoes).",
"type": "string",
"enum": [
"global",
"tops",
"coats-jackets-vests",
"pants",
"jeans",
"dresses::dresses-and-skirts",
"shoes",
"button-down-shirts",
"blazers-and-sports-jackets",
"t-shirts::t-shirts-and-sweaters",
"bras"
]
},
"sizeScheme": {
"description": "The size scheme of the size preference (e.g., US).",
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"sizeNumeric": {
"description": "The size numeric of the size preference (e.g., 9).",
"type": "array",
"minItems": 1,
"items": {
"type": "number",
"minimum": 0
}
},
"sizeAlphanumeric": {
"description": "The size alphanumeric of the size preference (e.g., x-large).",
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"00",
"6x-small",
"5x-small",
"4x-small",
"3x-small",
"xx-small",
"x-small",
"small",
"medium",
"large",
"x-large",
"xx-large",
"3x-large",
"4x-large",
"5x-large",
"6x-large",
"7x-large",
"1x",
"2x",
"3x",
"4x",
"5x",
"6x",
"7x",
"Not_Listed"
]
}
},
"normalizedSize": {
"description": "The normalized size of the size preference.",
"type": "object",
"additionalProperties": false,
"required": [
"size",
"dimensionType"
],
"properties": {
"size": {
"description": "The normalized size value of the size preference (e.g., 5).",
"type": "number"
},
"dimensionType": {
"description": "The normalized size dimension type of the size preference (e.g., primary).",
"type": "string",
"enum": [
"primary",
"length",
"width"
]
}
}
},
"modifier": {
"description": "The modifier of the size preference (e.g., wide).",
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"narrow",
"standard",
"wide",
"short",
"regular",
"long"
]
}
},
"brand": {
"description": "The brand of the size preference (e.g., gap).",
"type": "string",
"enum": [
"7-for-all-mankind",
"adidas",
"ag-adriano-goldschmied",
"aldo",
"allen-edmonds",
"allen-solly",
"alo-yoga",
"amazon-brand-symbol",
"amazon-essentials",
"american-eagle-outfitters",
"anne-klein",
"armani-exchange",
"asos",
"avec-les-filles",
"badgley-mischka",
"banana-republic",
"bcbg-max-azria",
"ben-sherman",
"billy-reid",
"black-halo",
"boohoo",
"buttoned-down",
"c-and-a",
"calvin-klein",
"carhartt",
"chaps",
"chaser",
"city-chic",
"clarks",
"club-monaco",
"cole-haan",
"columbia",
"converse",
"core-10",
"daily-ritual",
"dc",
"democracy",
"dennis-lingo",
"dickies",
"diesel",
"dl1961",
"dockers",
"dr-martens",
"ecco",
"eddie-bauer",
"express",
"fab-india",
"florsheim",
"forever-21",
"french-connection",
"frye",
"gap",
"global-desi",
"global-work",
"good-man-brand",
"goodthreads",
"gosriki",
"gu",
"h-and-m",
"helly-hansen",
"hugo-boss",
"hurley",
"izod",
"janasya",
"janina",
"jcrew",
"joes-jeans",
"john-varvatos",
"joie",
"journal-standard",
"kenneth-cole",
"lacoste",
"lark-and-ro",
"levis",
"loeffler-randall",
"lucky-brand",
"marc-jacobs",
"marks-and-spencer",
"marmot",
"matalan",
"max-fashion",
"milly",
"mizzen-plus-main",
"muji",
"nano-universe",
"nautica",
"new-balance",
"new-look",
"new-yorker",
"next",
"nike",
"niko-and-dotdotdot",
"nine-west",
"nydj",
"obey",
"old-navy",
"original-penguin",
"paige",
"parker",
"pendleton",
"pour-la-victoire",
"primark",
"puma",
"quiksilver",
"rebecca-taylor",
"reebok",
"rekucci",
"rip-curl",
"s-oliver",
"sam-edelman",
"seven7",
"shimamura",
"siril",
"soludos",
"sperry",
"splendid",
"star-vixen",
"steve-madden",
"stuart-weitzman",
"superga",
"takko",
"tcm",
"ted-baker",
"the-drop",
"the-kooples",
"theory",
"timberland",
"tommy-hilfiger",
"toms",
"topshop",
"ugg",
"under-armour",
"uniqlo",
"united-arrows",
"untuckit",
"urban-research",
"us-polo-assn",
"van-heusen",
"vero-moda",
"vince",
"vince-camuto",
"vineyard-vines",
"zanerobe",
"zara",
"Not_Listed"
]
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"sizePreferences": [
{
"department": "womens",
"category": "shoes",
"sizeScheme": "US",
"sizeNumeric": [
9
],
"sizeAlphanumeric": [
"x-large"
],
"normalizedSize": {
"size": 5,
"dimensionType": "primary"
},
"modifier":["wide"],
"brand":"gap"
}
]
}
Shopping preferences - interests
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
interestPreferences |
The interest preferences. | N/A |
interestPreferences.interestName |
The interest name. | star-wars |
interestPreferences.interestMetadata |
The interest metadata. | N/A |
interestPreferences.interestMetadata.responseMarketplaceId |
The interest metadata marketplace identifier. | DE |
interestPreferences.interestMetadata.responseTimestamp |
The interest metadata response timestamp. | 2023-11-28T21:54:11.310Z |
interestPreferences.interestMetadata.responseSource |
The interest metadata response source. | N/A |
interestPreferences.interestMetadata.responseSource.deviceType |
The interest metadata response source device type. | mobile |
interestPreferences.interestMetadata.responseSource.pageType |
The interest metadata response source page type. | fan-shop |
interestPreferences.interestMetadata.responseSource.experienceType |
The interest metadata response source experience type. | adder |
interestPreferences.interestMetadata.responseSource.sourceType |
The interest metadata response source type. | N/A |
interestPreferences.interestMetadata.responseSource.sourceType.modelVersion |
The interest metadata response source type model version. | 2 |
interestPreferences.interestMetadata.responseSource.sourceType.source |
The interest metadata response source type value. | behavior-based-sustainability-targeting-model |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Interests",
"description": "Includes the interests shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"interestPreferences"
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"interestPreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The interest preferences.",
"items": {
"type": "object",
"required": [
"interestName",
"interestMetadata"
],
"properties": {
"interestName": {
"description": "The interest name (e.g., star-wars).",
"type": "string"
},
"interestMetadata": {
"description": "The interest metadata.",
"type": "object",
"required": [
"response",
"responseMarketplaceId",
"responseTimestamp",
"responseSource"
],
"properties": {
"response": {
"type": "string",
"enum": [
"yes",
"no"
]
},
"responseMarketplaceId": {
"description": "The interest metadata marketplace identifier (e.g., DE).",
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"responseTimestamp": {
"description": "The interest metadata response timestamp (e.g., 2023-11-28T21:54:11.310Z).",
"type": "string",
"format": "date-time"
},
"responseSource": {
"description": "The interest metadata response source.",
"type": "object",
"properties": {
"deviceType": {
"description": "The interest metadata response source device type (e.g., mobile).",
"type": "string",
"enum": [
"mobile",
"desktop",
"unknown"
]
},
"pageType": {
"description": "The interest metadata response source page type (e.g., fan-shop).",
"type": "string",
"enum": [
"browse",
"cart",
"detail",
"fan-shop",
"gateway",
"inspire",
"shop-by-interest",
"me-tab",
"personalized-interest",
"profile-hub",
"search",
"thank-you",
"your-interests"
]
},
"experienceType": {
"description": "The interest metadata response source experience type (e.g., adder).",
"type": "string",
"enum": [
"adder",
"banner",
"confirmation-card",
"follow-button",
"pop-up",
"profile-hub",
"profile-picker"
]
},
"sourceType": {
"description": "The interest metadata response source type.",
"type": "object",
"properties": {
"source": {
"description": "The interest metadata response source type value (e.g., behavior-based-sustainability-targeting-model).",
"type": "string",
"enum": [
"location",
"search-history",
"product-view-history",
"purchase-history",
"purchase-action",
"behavior-based-sustainability-targeting-model",
"behavior-based-targeting-model",
"add-to-cart-action"
]
},
"modelVersion": {
"description": "The interest metadata response source type model version (e.g., 2).",
"type": "number"
}
}
}
}
}
}
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"interestPreferences": [
{
"interestName": "star-wars",
"interestMetadata": {
"response": "yes",
"responseMarketplaceId": "DE",
"responseTimestamp": "2023-11-28T21:54:11.310Z",
"responseSource": {
"deviceType": "mobile",
"pageType": "fan-shop",
"experienceType": "adder",
"sourceType": {
"source": "behavior-based-sustainability-targeting-model",
"modelVersion": 2
}
}
}
}
]
}
Shopping preferences - fit
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
fitPreferences |
The fit preferences. | N/A |
fitPreferences.department |
The fit preference department. | mens |
fitPreferences.category |
The fit preference category. | tops |
fitPreferences.response |
The fit preference response. | fitted |
fitConsiderations |
The fit considerations. | N/A |
fitConsiderations.department |
The fit considerations department. | womens |
fitConsiderations.category |
The fit considerations category. | fit-consideration |
fitConsiderations.response |
The fit considerations response. | maternity |
fitConsiderationResponses |
The fit consideration responses. | N/A |
fitConsiderationResponses.department |
The fit consideration responses department. | womens |
fitConsiderationResponses.category |
The fit consideration responses category. | fit-consideration-response |
fitConsiderationResponses.response |
The fit consideration responses response. | Size is too small |
fitMeasurements |
The fit measurements. | N/A |
fitMeasurements.category |
The fit measurements category. | neck |
fitMeasurements.measurement |
The fit measurements measurement. | N/A |
fitMeasurements.measurement.length |
The fit measurements measurement length. | 34 |
fitMeasurements.measurement.unit |
The fit measurements measurement unit. | in |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Fit",
"description": "Includes the fit shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"fitPreferences",
"eventDate"
]
},
{
"required": [
"fitConsiderations",
"eventDate"
]
},
{
"required": [
"fitConsiderationResponses",
"eventDate"
]
},
{
"required": [
"fitMeasurements",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"fitPreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The fit preferences.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The fit preference department (e.g., mens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The fit preference category (e.g., tops).",
"type": "string",
"enum": [
"tops",
"pants::bottoms",
"jeans",
"dresses::dresses-and-skirts",
"shoes::heel-height",
"dresses::dress-silhouette",
"button-down-shirts",
"blazers-and-sports-jackets",
"pants"
]
},
"response": {
"description": "The fit preference response (e.g., fitted).",
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"fitted",
"loose",
"straight",
"above-knee",
"knee-length",
"long",
"midi",
"fit-flare",
"maxi",
"bootcut",
"boyfriend",
"cropped",
"skinny",
"wide",
"flat",
"high",
"low",
"medium",
"slim",
"classic",
"relaxed",
"No_Response"
]
}
}
}
}
},
"fitConsiderations": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The fit considerations.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The fit considerations department (e.g., womens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The fit considerations category (e.g., fit-consideration).",
"type": "string",
"enum": [
"fit-consideration"
]
},
"response": {
"description": "The fit considerations response (e.g., maternity).",
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"maternity",
"petite",
"plus-size",
"regular",
"tall",
"No_Response"
]
}
}
}
}
},
"fitConsiderationResponses": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The fit consideration responses.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The fit consideration responses department (e.g., womens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The fit consideration responses category (e.g., fit-consideration-response).",
"type": "string",
"enum": [
"fit-consideration-response"
]
},
"response": {
"description": "The fit consideration responses response (e.g., Size is too small).",
"type": "string",
"minLength": 1,
"maxLength": 1024
}
}
}
},
"fitMeasurements": {
"type": "array",
"additionalProperties": false,
"description": "The fit measurements.",
"items": {
"required": [
"category",
"measurement"
],
"type": "object",
"properties": {
"category": {
"description": "The fit measurements category (e.g., neck).",
"type": "string",
"enum": [
"neck",
"sleeve",
"waist",
"bust",
"chest",
"hip",
"inseam",
"outseam",
"shoulders",
"ribcage"
]
},
"measurement": {
"description": "The fit measurements measurement.",
"type": "object",
"additionalProperties": false,
"required": [
"length",
"unit"
],
"properties": {
"length": {
"description": "The fit measurements measurement length (e.g., 34).",
"type": "number",
"minimum": 0
},
"unit": {
"description": "The fit measurements measurement unit (e.g., in).",
"type": "string",
"enum": [
"cm",
"in"
]
}
}
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"fitPreferences": [
{
"department": "mens",
"category": "tops",
"response": [
"fitted"
]
}
],
"fitConsiderations": [
{
"department": "womens",
"category": "fit-consideration",
"response": [
"maternity"
]
}
],
"fitConsiderationResponses": [
{
"department": "womens",
"category": "fit-consideration-response",
"response": "Size is too small"
}
],
"fitMeasurements": [
{
"category": "neck",
"measurement": {
"length": 34,
"unit": "in"
}
}
]
}
Shopping preferences - events
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
promotionalEvent |
The promotional event preference. | N/A |
promotionalEvent.eventType |
The event type of the promotional event. | thursday-night-football |
promotionalEvent.eventChoice |
The event choice of the promotional event. | dismiss |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Events",
"description": "Includes the events shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"promotionalEvent"
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"promotionalEvent": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The promotional event preference.",
"items": {
"type": "object",
"required": [
"eventType",
"eventChoice"
],
"properties": {
"eventType": {
"description": "The event type of the promotional event (e.g., thursday-night-football).",
"type": "string",
"enum": [
"back-to-school",
"mothers-day",
"thursday-night-football",
"wedding"
]
},
"eventChoice": {
"description": "The event choice of the promotional event (e.g., dismiss).",
"type": "string",
"enum": [
"dismiss",
"like",
"no-preference"
]
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"promotionalEvent": [
{
"eventType": "thursday-night-football",
"eventChoice": "dismiss"
}
]
}
Shopping preferences - price
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
apparelPricePreferences |
The price range preferences. | N/A |
apparelPricePreferences.department |
The department of the apparel price preferences. | mens |
apparelPricePreferences.category |
The category of the apparel price preferences. | shoes |
apparelPricePreferences.minResponse |
The minimum of the apparel price preference. | N/A |
apparelPricePreferences.minResponse.amount |
The minimum value of the apparel price preference. | 15 |
apparelPricePreferences.minResponse.currency |
The minimum currency of the apparel price preference. | usd |
apparelPricePreferences.maxResponse |
The maximum of the apparel price preference. | N/A |
apparelPricePreferences.maxResponse.amount |
The maximum value of the apparel price preference. | 300 |
apparelPricePreferences.maxResponse.currency |
The maximum currency of the apparel price preference. | usd |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Price",
"description": "Includes the price shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"apparelPricePreferences"
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"apparelPricePreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The price range preferences.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"minResponse",
"maxResponse"
],
"properties": {
"department": {
"description": "The department of the apparel price preferences (e.g., mens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the apparel price preferences (e.g., shoes).",
"type": "string",
"enum": [
"tops",
"coats-jackets-vests",
"pants",
"jeans",
"dresses::dresses-and-skirts",
"shoes",
"sweaters",
"t-shirts",
"jackets-coats",
"button-down-shirts",
"blazers-and-sports-jackets"
]
},
"minResponse": {
"description": "The minimum of the apparel price preference.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "The minimum value of the apparel price preference (e.g., 15).",
"type": "number"
},
"currency": {
"description": "The minimum currency of the apparel price preference (e.g., usd).",
"type": "string",
"enum": [
"usd"
]
}
}
},
"maxResponse": {
"description": "The maximum of the apparel price preference.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "The maximum value of the apparel price preference (e.g., 300).",
"type": "number"
},
"currency": {
"description": "The maximum currency of the apparel price preference (e.g., usd).",
"type": "string",
"enum": [
"usd"
]
}
}
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"apparelPricePreferences": [
{
"department": "mens",
"category": "shoes",
"minResponse": {
"amount": 15,
"currency": "usd"
},
"maxResponse": {
"amount": 300,
"currency": "usd"
}
}
]
}
Shopping preferences - bulk shopping
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
intents |
The intent to shop in bulk. | bulk |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Bulk Shopping",
"description": "Includes the intent to shop in bulk configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"intents"
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"intents": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 1,
"description": "The intent to shop in bulk (e.g., bulk).",
"items": {
"type": "string",
"enum": [
"bulk"
]
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"intents": [
"bulk"
]
}
Shopping preferences - sustainability
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
sustainabilityLabelPreferences |
The climate pledge friendly preferences. | N/A |
sustainabilityLabelPreferences.label |
The label of the sustainability label preference. | carbon-impact |
sustainabilityLabelPreferences.preference |
The preference of the sustainability label preference. | yes |
sustainabilitySearchPreference |
The climate pledge friendly search preference. | yes |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Sustainability",
"description": "Includes the sustainability shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"sustainabilityLabelPreferences",
"eventDate"
]
},
{
"required": [
"sustainabilitySearchPreference",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"sustainabilityLabelPreferences": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The climate pledge friendly preferences.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"label",
"preference"
],
"properties": {
"label": {
"description": "The label of the sustainability label preference (e.g., carbon-impact).",
"type": "string",
"enum": [
"carbon-impact",
"recycled-materials",
"manufacturing-practices",
"animal-welfare",
"energy-efficiency",
"forestry-practices",
"safer-chemicals",
"packaging-efficiency",
"organic-content",
"worker-wellbeing",
"water-and-soil-quality",
"biodiversity",
"circularity",
"water-efficiency",
"general"
]
},
"preference": {
"description": "The preference of the sustainability label preference (e.g., yes).",
"type": "string",
"enum": [
"yes",
"no",
"No_Response"
]
}
}
}
},
"sustainabilitySearchPreference": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The climate pledge friendly search preference (e.g., yes).",
"items": {
"type": "string",
"enum": [
"yes",
"no",
"No_Response"
]
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"sustainabilityLabelPreferences": [
{
"label": "carbon-impact",
"preference": "yes"
}
],
"sustainabilitySearchPreference": [
"yes"
]
}
Shopping preferences - clothing fit
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
shoulders |
The shoulder fit preference. | average |
chest |
The chest fit preference. | narrow |
waist |
The waist fit preference. | average |
hips |
The hips fit preference. | wide |
thighs |
The thighs fit preference. | average |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Clothing Fit",
"description": "Includes the clothing fit shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"shoulders",
"eventDate"
]
},
{
"required": [
"chest",
"eventDate"
]
},
{
"required": [
"waist",
"eventDate"
]
},
{
"required": [
"hips",
"eventDate"
]
},
{
"required": [
"thighs",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"shoulders": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"description": "The shoulder fit preference (e.g., average).",
"items": {
"type": "string",
"enum": [
"average",
"narrow",
"wide",
"No_Response"
]
}
},
"chest": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"description": "The chest fit preference (e.g., narrow).",
"items": {
"type": "string",
"enum": [
"average",
"narrow",
"wide",
"No_Response"
]
}
},
"waist": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"description": "The waist fit preference (e.g., average).",
"items": {
"type": "string",
"enum": [
"average",
"narrow",
"wide",
"No_Response"
]
}
},
"hips": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"description": "The hips fit preference (e.g., wide).",
"items": {
"type": "string",
"enum": [
"average",
"narrow",
"wide",
"No_Response"
]
}
},
"thighs": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"description": "The thighs fit preference (e.g., average).",
"items": {
"type": "string",
"enum": [
"average",
"narrow",
"wide",
"No_Response"
]
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"shoulders": [
"average"
],
"chest": [
"narrow"
],
"waist": [
"average"
],
"hips": [
"wide"
],
"thighs": [
"average"
]
}
Shopping preferences - body
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
bodyShape |
The shape of the body. | N/A |
bodyShape.department |
The department of the shape of the body. | womens |
bodyShape.category |
The category of the shape of the body. | body-shape |
bodyShape.response |
The value of the shape of the body. | hourglass |
bodyFocus |
The focus info for different body parts. | N/A |
bodyFocus.department |
The department of the body focus. | mens |
bodyFocus.category |
The category of the body focus. | arms |
bodyFocus.response |
The value of the body focus. | hide |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Body",
"description": "Includes the body shopping preferences configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"bodyShape",
"eventDate"
]
},
{
"required": [
"bodyFocus",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"bodyShape": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The shape of the body.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The department of the shape of the body (e.g., womens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the shape of the body (e.g., body-shape).",
"type": "string",
"enum": [
"body-shape"
]
},
"response": {
"description": "The value of the shape of the body (e.g., hourglass).",
"type": "string",
"enum": [
"hourglass",
"invertedtriangle",
"rectangle",
"round",
"triangle",
"No_Response"
]
}
}
}
},
"bodyFocus": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The focus info for different body parts.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"department",
"category",
"response"
],
"properties": {
"department": {
"description": "The department of the body focus (e.g., mens).",
"type": "string",
"enum": [
"mens",
"womens",
"No_Response"
]
},
"category": {
"description": "The category of the body focus (e.g., arms).",
"type": "string",
"enum": [
"arms",
"legs",
"waist",
"chest",
"hips",
"back"
]
},
"response": {
"description": "The value of the body focus (e.g., hide).",
"type": "string",
"enum": [
"hide",
"neutral",
"highlight",
"No_Response"
]
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"bodyShape": [
{
"department": "womens",
"category": "body-shape",
"response": "hourglass"
}
],
"bodyFocus": [
{
"department": "mens",
"category": "arms",
"response": "hide"
}
]
}
Shopping preferences - customer
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
ageRange |
The age range of the customer in bands of 5 years. | 21-25 |
socialMediaLinks |
The social media links. | N/A |
socialMediaLinks.category |
The category of the social media link. | facebook |
socialMediaLinks.response |
The value of the social media link. | https://www.facebook.com/username |
requestedADAAccommodations |
The disability accommodations. | N/A |
requestedADAAccommodations.category |
The category of the disability accommodations. | fitting-room |
requestedADAAccommodations.response |
The value of the disability accommodations. | no |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Shopping Preferences - Customer",
"description": "Includes the customer preferences profile configured by the customer.",
"type": "object",
"unevaluatedProperties": false,
"anyOf": [
{
"required": [
"ageRange",
"eventDate"
]
},
{
"required": [
"socialMediaLinks",
"eventDate"
]
},
{
"required": [
"requestedADAAccommodations",
"eventDate"
]
}
],
"properties": {
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
},
"ageRange": {
"type": "array",
"description": "The age range of the customer in bands of 5 years (e.g., 21-25).",
"items": {
"type": "string"
}
},
"socialMediaLinks": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The social media links.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"description": "The category of the social media link (e.g., facebook).",
"type": "string",
"enum": [
"facebook",
"pinterest",
"instagram"
]
},
"response": {
"description": "The value of the social media link (e.g., https://www.facebook.com/username).",
"type": "string",
"maxLength": 256,
"pattern": "^(https?://.*$)|(No_Response$)"
}
}
}
},
"requestedADAAccommodations": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "The disability accommodations.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"category",
"response"
],
"properties": {
"category": {
"description": "The category of the disability accommodations (e.g., fitting-room).",
"type": "string",
"enum": [
"fitting-room"
]
},
"response": {
"description": "The value of the disability accommodations (e.g., no).",
"type": "string",
"enum": [
"yes",
"no"
]
}
}
}
}
}
}
Sample data based on the sample schema:
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"ageRange": [
"21-25"
],
"socialMediaLinks": [
{
"category": "facebook",
"response": "https://www.facebook.com/username"
}
],
"requestedADAAccommodations": [
{
"category": "fitting-room",
"response": "no"
}
]
}
Sports interests
This scope includes Amazon customer's confirmed sports interests and poll responses.
Identifiers:
- Login with Amazon Scope Name:
portability::interests
- Amazon Data Portability
scopeId
:portability-interests
Sports interests - poll responses
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
pickAWinnerCustomerResponsesGame |
The game on which the customer voted. It contains the participants, day, and time of the game. | usa-football-arizona-cardinals vs. usa-football-seattle-seahawks | Game Time: 2021-06-08T06:08:00 |
customerTeamVote |
The participant for which the customer voted. | usa-football-seattle-seahawks |
customerResponseTime |
The time when the customer took the vote action, in the ISO 8601 date-time format and UTC time zone. | 2021-09-29T11:04:43.305Z |
customerVoteRegion |
The region where the experience was showed to the customer. | Germany |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Sport Interests - Poll Responses",
"description": "Includes customer's sports interests poll responses.",
"type": "array",
"items": {
"type": "object",
"properties": {
"pickAWinnerCustomerResponsesGame": {
"description": "The game on which the customer voted. It contains the participants, day, and time of the game (e.g., usa-football-arizona-cardinals vs. usa-football-seattle-seahawks | Game Time: 2021-06-08T06:08:00).",
"type": "string"
},
"customerTeamVote": {
"description": "The participant for which the customer voted (e.g., usa-football-seattle-seahawks).",
"type": "string"
},
"customerResponseTime": {
"description": "The time when the customer took the vote action, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"customerVoteRegion": {
"description": "The region where the experience was showed to the customer (e.g., Germany).",
"type": "string"
},
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
}
},
"unevaluatedProperties": false,
"required": [
"pickAWinnerCustomerResponsesGame",
"customerTeamVote",
"customerResponseTime",
"marketplace",
"eventDate"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"pickAWinnerCustomerResponsesGame": "usa-football-arizona-cardinals vs. usa-football-seattle-seahawks | Game Time: 2021-06-08T06:08:00",
"customerTeamVote": "usa-football-seattle-seahawks",
"customerResponseTime": "2021-09-29T11:04:43.305Z",
"customerVoteRegion": "Germany"
}
]
Sports interests - confirmed interests
Schema properties:
Properties | Details | Example value |
---|---|---|
marketplace |
The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. | DE |
eventDate |
The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). | 2021-09-29T11:04:43.305Z |
interestName |
The name of the interest. | fishing |
isInterested |
The flag that specifies the affinity towards the interest. | true |
lastUpdatedDate |
The date that the record was last updated by a customer action, in the ISO 8601 date-time format and UTC time zone. | 2021-09-29T11:04:43.305Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Sport Interests - Confirmed Interests",
"description": "Includes customer's confirmed sports interests.",
"type": "array",
"items": {
"type": "object",
"properties": {
"interestName": {
"description": "The name of the interest (e.g., fishing).",
"type": "string"
},
"isInterested": {
"description": "The flag that specifies the affinity towards the interest (e.g., true).",
"type": "boolean"
},
"lastUpdatedDate": {
"description": "The date that the record was last updated by a customer action, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
"type": "string",
"format": "date-time"
},
"marketplace": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
}
},
"unevaluatedProperties": false,
"required": [
"interestName",
"isInterested",
"lastUpdatedDate",
"marketplace",
"eventDate"
]
}
}
Sample data based on the sample schema:
[
{
"marketplace": "DE",
"eventDate": "2021-09-29T11:04:43.305Z",
"interestName": "fishing",
"isInterested": true,
"lastUpdatedDate": "2021-09-29T11:04:43.305Z"
}
]
Category-3 Scopes
To gain access to Category-3 scopes, you will complete the business identity and data security verification in Step 2. Identity and security assessment.
Alexa Settings
This bucket includes information about how customers set up Alexa on their device:
Alexa account settings
This scope includes customer's Alexa account preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::alexa_account_settings
- Amazon Data Portability
scopeId
:portability-alexa-account-settings
Alexa account settings
Schema properties:
Properties | Details | Example value |
---|---|---|
settingKey |
The description of the setting (e.g., Alexa.Presence.videoDetectionMode). | System.locales |
value |
The value of the setting (e.g., OFF). | en-US |
principalType |
The type of the setting. | Device Setting |
eventDate |
Last updated time for the setting. | 1970-01-01T00:00:00Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Alexa Settings",
"description": "Includes Device, Account and Person Settings.",
"type": "array",
"items": {
"type": "object",
"properties": {
"settingKey": {
"description": "The description of the setting (e.g., Alexa.Presence.videoDetectionMode).",
"type": "string"
},
"value": {
"description": "The value of the setting (e.g., OFF).",
"type": [
"string",
"boolean",
"object",
"number",
"array"
]
},
"principalType": {
"description": "The type of the setting.",
"type": "string"
},
"eventDate": {
"description": "Last updated time for the setting.",
"type": "string"
}
},
"required": [
"settingKey",
"value",
"principalType",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"settingKey": "System.locales",
"value": "en-US",
"principalType": "Device Setting",
"eventDate": "1970-01-01T00:00:00Z"
}
]
Alexa audio pairings
This scope includes customer's multi-room audio setup configuration.
Identifiers:
- Login with Amazon Scope Name:
portability::alexa_audio_pairings
- Amazon Data Portability
scopeId
:portability-alexa-audio-pairings
Audio Group Settings
Schema properties:
Properties | Details | Example value |
---|---|---|
clusterName |
Speaker group friendly name. | Great Room |
groupType |
Type of speaker group. | A3C9PE6BDELTCH |
clusterMembers |
List of device serial numbers that compose the cluster. | GK022H07251601SH, GK022H07251601SS |
audioSyncDeviceSkews |
A map of cluster member device id to corresponding Bluetooth skew time data when applicable to device. | {GK022H07251601SH: 181.102} |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Audio Group Settings - Audio Groups",
"description": "Includes details about a customer's audio groups",
"type": "array",
"items": {
"type": "object",
"properties": {
"clusterName": {
"type": "string",
"description": "Speaker group friendly name"
},
"groupType": {
"type": "string",
"description": "Type of speaker group"
},
"clusterMembers": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of device serial numbers that compose the cluster"
},
"audioSyncDeviceSkews": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of cluster member device id to corresponding bluetooth skew time data when applicable to device"
}
},
"required": [
"clusterName",
"groupType",
"clusterMembers"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"clusterName": "Great Room",
"groupType": "A3C9PE6BDELTCH",
"clusterMembers": ["GK022H07251601SH", "GK022H07251601SS"],
"audioSyncDeviceSkews": {
"GK022H07251601SH": "181.102"
}
}
]
Pairing Suggestions
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Device serial number of device being registered. | GK022H07251601SH |
pairingSuggestionDevices |
List of device serial numbers corresponding to devices suggested for pairing with new device registered. | GK022H07251601SH, GK022H07251601SS |
creationTime |
Timestamp corresponding to pairing suggestion record creation. | 2024-08-10T22:51:54Z |
updatedTime |
Timestamp corresponding to most recent update for pairing suggestion record. | 2024-08-10T22:51:54Z |
eventDate |
The date when the pairing suggestion was created or updated. | 2024-08-10T22:51:54Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Pairing Suggestions",
"description": "Includes details about suggested device pairings",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number of device being registered"
},
"pairingSuggestionDevices": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of device serial numbers corresponding to devices suggested for pairing with new device registered"
},
"creationTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp corresponding to pairing suggestion record creation"
},
"updatedTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp corresponding to most recent update for pairing suggestion record"
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the pairing suggestion was created or updated"
}
},
"required": [
"deviceSerialNumber",
"pairingSuggestionDevices",
"creationTime",
"updatedTime",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "GK022H07251601SH",
"pairingSuggestionDevices": ["GK022H07251601SH", "GK022H07251601SS"],
"creationTime": "2024-08-10T22:51:54Z",
"updatedTime": "2024-08-10T22:51:54Z",
"eventDate": "2024-08-10T22:51:54Z"
}
]
Alexa reminders
This scope includes customer's reminder preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::alexa_reminders
- Amazon Data Portability
scopeId
:portability-alexa-reminders
Alexa reminders
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceName |
Name of device provided by customer. | Nick's Echo Show |
eventDate |
Created date of the DB entry. | 2022-07-05T00:56 |
reminderType |
Type of notification. | Reminder |
timezone |
Timezone. | America/Los_Angeles |
scheduledDateAndTime |
Trigger date and time of reminder. | 2022-04-27T01:30:00.000Z |
lastUpdatedDate |
Last updated date. | 2022-04-27T01:30 |
stoppedTime |
Stopped time. | 2022-04-27T01:30 |
skillName |
Name of the skill that created the reminder. | Alexa Smart Home |
label |
Label of the task. | Walk the dog |
reminderStatus |
Status of the reminder or task. | ON |
personalizationType |
Whether the reminder was personal or assigned. | Personal |
assigner |
Name of the person in the household who assigned the task. | John Smith |
assignee |
Name of the person in the household who the task is assigned to. | Jane Smith |
reminderDurationInMilliseconds |
Duration of time in milliseconds until a reminder should trigger. | 0 |
reminderDeferredTime |
Time at which a reminder was deferred. | 2019-10-09T02:48:36.515Z |
scheduledTime |
Reminder's trigger time. | 15:30 |
recurrenceStartDate |
Date of when recurring reminder should start. | 2022-04-27T01:30:00.000Z |
recurrenceStartTime |
Time of when recurring reminder should start. | 01:30 |
recurrenceEndDate |
Date of when recurring reminder should end. | 2022-04-27T01:30:00.000Z |
recurrenceEndTime |
Time of when recurring reminder should end. | 01:30 |
recurrence |
Recurrence rules associated with a reminder. | Every Monday |
followUpReminder |
Flag if the reminder set is a follow up and requires completion to stop ringing. | Yes |
pushNotifications |
Flag if customer has push notifications enabled on reminder delivery. | Enabled |
deliveryMode |
Mode in how reminders are delivered. | All devices |
reminderAnnouncementRepetitions |
Number of times a reminder is announced upon delivery. | 1 |
disableDefaultReminderAnnouncementRepetitions |
Flag if customer overrode the default number of times a reminder is announced upon delivery. | No |
taskNote |
Note associated with the task. | Fix the computer |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Reminders",
"description": "Includes details about reminders, tasks, and notifications created by customers",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceName": {
"type": "string",
"description": "Name of device provided by customer."
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "Created date of the DB entry."
},
"type": {
"type": "string",
"description": "Type of notification."
},
"timezone": {
"type": "string",
"description": "Timezone."
},
"scheduledDateAndTime": {
"type": "string",
"description": "Trigger date and time of reminder."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Last updated date."
},
"stoppedTime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Applicable"
}
],
"description": "Stopped time."
},
"skillName": {
"type": "string",
"description": "Name of the skill that created the reminder."
},
"label": {
"type": "string",
"description": "Label of the task."
},
"status": {
"type": "string",
"enum": [
"OFF",
"ON",
"SNOOZED",
"PAUSED",
"Incomplete",
"Complete",
"Not Available",
"Not Applicable"
],
"description": "Status of the reminder or task."
},
"personalizationType": {
"type": "string",
"enum": [
"Personal",
"Assigned",
"Not Applicable"
],
"description": "Whether the reminder was personal or assigned."
},
"assigner": {
"type": "string",
"description": "Name of the person in the household who assigned the task."
},
"assignee": {
"type": "string",
"description": "Name of the person in the household who the task is assigned to."
},
"reminderDurationInMilliseconds": {
"type": "string",
"description": "Duration of time in milliseconds until a reminder should trigger."
},
"reminderDeferredTime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Applicable"
}
],
"description": "Time at which a reminder was deferred."
},
"scheduledTime": {
"type": "string",
"description": "Reminder's trigger time."
},
"recurrenceStartDate": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Applicable"
}
],
"description": "Date of when recurring reminder should start."
},
"recurrenceStartTime": {
"type": "string",
"description": "Time of when recurring reminder should start."
},
"recurrenceEndDate": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Applicable"
}
],
"description": "Date of when recurring reminder should end."
},
"recurrenceEndTime": {
"type": "string",
"description": "Time of when recurring reminder should end."
},
"recurrence": {
"type": "string",
"description": "Recurrence rules associated with a reminder."
},
"followUpReminder": {
"type": "string",
"enum": [
"Yes",
"No",
"Not Applicable"
],
"description": "Flag if the reminder set is a follow up and requires completion to stop ringing."
},
"pushNotifications": {
"type": "string",
"enum": [
"Enabled",
"Disabled",
"Not Applicable"
],
"description": "Flag if customer has push notifications enabled on reminder delivery."
},
"deliveryMode": {
"type": "string",
"enum": [
"All devices",
"Spoken device",
"Nearby devices",
"Device group",
"Not Applicable"
],
"description": "Mode in how reminders are delivered."
},
"reminderAnnouncementRepetitions": {
"type": "string",
"enum": [
"1",
"2",
"3",
"Persistent",
"Not Applicable"
],
"description": "Number of times a reminder is announced upon delivery."
},
"disableDefaultReminderAnnouncementRepetitions": {
"type": "string",
"enum": [
"Yes",
"No",
"Not Applicable"
],
"description": "Flag if customer overrode the default number of times a reminder is announced upon delivery."
},
"taskNote": {
"type": "string",
"description": "Note associated with the task."
}
},
"required": [
"deviceName",
"createdDate",
"type",
"timezone",
"eventDate",
"label",
"status",
"pushNotifications"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceName": "Nick's Echo Show",
"createdDate": "2022-07-05T00:56",
"type": "Reminder",
"timezone": "America/Los_Angeles",
"scheduledDateAndTime": "2022-04-27T01:30:00.000Z",
"eventDate": "2022-04-27T01:30",
"stoppedTime": "2022-04-27T01:30",
"skillName": "Alexa Smart Home",
"label": "Walk the dog",
"status": "ON",
"personalizationType": "Personal",
"assigner": "John Smith",
"assignee": "Jane Smith",
"reminderDurationInMilliseconds": "0",
"reminderDeferredTime": "2019-10-09T02:48:36.515Z",
"scheduledTime": "15:30",
"recurrenceStartDate": "2022-04-27T01:30:00.000Z",
"recurrenceStartTime": "01:30",
"recurrenceEndDate": "2022-04-27T01:30:00.000Z",
"recurrenceEndTime": "01:30",
"recurrence": "Every Monday",
"followUpReminder": "Yes",
"pushNotifications": "Enabled",
"deliveryMode": "All devices",
"reminderAnnouncementRepetitions": "1",
"disableDefaultReminderAnnouncementRepetitions": "No",
"taskNote": "Fix the computer"
}
]
Alexa Video Pairings
This scope includes customer's device-related app usage.
Identifiers:
- Login with Amazon Scope Name:
portability::alexa_video_pairings
- Amazon Data Portability
scopeId
:portability-alexa-video-pairings
Alexa Video Pairings
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The ISO 8601 formatted timestamp of when this pairing association was updated. Not indicative of when pairing was initially created but last updated. | 2024-05-13T17:12:25.399Z |
status |
Whether or not this pairing association should be ignored. | Enabled |
type |
Whether or not is NestedTargetDevice. This field indicating indirect device associations through a host device when there's no direct link between the source and target devices. | Application |
isWelcomeMessagePlayed |
Whether or not this device association should render a welcome message when the app is targeted. | true |
sourceDeviceSerialNumber |
Source device's Amazon device serial number. | GXX0VC3R8A9R734L |
sourceDeviceType |
A friendly name of source device's device type. | Echo Show |
targetDeviceSerialNumber |
Target device's Amazon device serial number. | GXX15X3SH7V5V14S |
deviceRefreshTime |
The ISO 8601 formatted timestamp of when target device will become inactive. | 1970-01-01T00:00:00Z |
deviceLastAccessedTime |
The ISO 8601 formatted timestamp of the directive sent to the target device. | 1970-01-01T00:00:00Z |
targetAppName |
Name of the target application, eg, Prime Video, Hulu. If it does not exist, this field would be Not Available. | Prime Video |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Pairing",
"description": "Device pairing information for Alexa Video devices.",
"type": "array",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The ISO 8601 formatted timestamp of when this pairing association was updated. Not indicative of when pairing was initially created but last updated."
},
"status": {
"type": "string",
"description": "Whether or not this pairing association should be ignored."
},
"type": {
"type": "string",
"description": "Whether or not is NestedTargetDevice. This field indicating indirect device associations through a host device when there's no direct link between the source and target devices."
},
"isWelcomeMessagePlayed": {
"type": "boolean",
"description": "Whether or not this device association should render a welcome message when the app is targeted."
},
"sourceDeviceSerialNumber": {
"type": "string",
"description": "Source device's Amazon device serial number."
},
"sourceDeviceType": {
"type": "string",
"description": "A friendly name of source device's device type."
},
"targetDeviceSerialNumber": {
"type": "string",
"description": "Target device's Amazon device serial number."
},
"deviceRefreshTime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Available"
}
],
"description": "The ISO 8601 formatted timestamp of when target device will become inactive."
},
"deviceLastAccessedTime": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Available"
}
],
"description": "The ISO 8601 formatted timestamp of the directive sent to the target device."
},
"targetAppName": {
"type": "string",
"description": "Name of the target application, eg, Prime Video, Hulu. If it does not exist, this field would be Not Available."
}
},
"required": [
"eventDate",
"status",
"type",
"isWelcomeMessagePlayed",
"sourceDeviceSerialNumber",
"sourceDeviceType",
"targetDeviceSerialNumber",
"deviceRefreshTime",
"deviceLastAccessedTime",
"targetAppName"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2024-05-13T17:12:25.399Z",
"status": "Enabled",
"type": "Application",
"isWelcomeMessagePlayed": true,
"sourceDeviceSerialNumber": "GXX0VC3R8A9R734L",
"sourceDeviceType": "Echo Show",
"targetDeviceSerialNumber": "GXX15X3SH7V5V14S",
"deviceRefreshTime": "1970-01-01T00:00:00.000Z",
"deviceLastAccessedTime": "1970-01-01T00:00:00.000Z",
"targetAppName": "Prime Video"
}
]
Alexa whisper preferences
This scope includes customer's whisper mode preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::alexa_whisper_preferences
- Amazon Data Portability
scopeId
:portability-alexa_whisper_preferences
Whisper notice state
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Device serial number. | G123MW45678901A2 |
whisperInvitationDate |
The date at which the whisper invitation was sent for the given device. | 2024-03-29T19:20:21.777Z |
whisperNotificationDate |
The date at which the whisper notification was sent for the given device. The whisper notification informs the customer that the device will whisper. | 2024-03-29T19:20:21.777Z |
eventDate |
The date when the entry was last updated. | 2024-04-16T19:20:21.999Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "WhisperNoticeState",
"description": "Persists information about whether the customer has been notified, per device, about the whisper feature prior to their first whisper interaction.",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"description": "Device serial number",
"type": "string"
},
"whisperInvitationDate": {
"description": "The date at which the whisper invitation was sent for the given device.",
"type": "string",
"format": "date-time"
},
"whisperNotificationDate": {
"description": "The date at which the whisper notification was sent for the given device. The whisper notification informs the customer that the device will whisper.",
"type": "string",
"format": "date-time"
},
"eventDate": {
"description": "The date when the entry was last updated.",
"type": "string",
"format": "date-time"
}
},
"required": [
"deviceSerialNumber",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "G123MW45678901A2",
"whisperInvitationDate": "2024-03-29T19:20:21.777Z",
"whisperNotificationDate": "2024-03-29T19:20:21.777Z",
"eventDate": "2024-04-16T19:20:21.999Z"
}
]
Whisper applied device effects
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Device serial number. | G123MW45678901A2 |
actualVolume |
Original customer device volume before modifying it for whisper. | 50 |
whisperVolume |
Indicates whether the device volume was modified for whisper. | ON |
eventDate |
The date when the entry was created. | 2024-04-16T19:20:21.999Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "WhisperAppliedDeviceEffects",
"description": "Persists information about the customer's device volume in order to support the whisper feature.",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"description": "Device serial number",
"type": "string"
},
"actualVolume": {
"description": "Original customer device volume before modifying it for whisper.",
"type": "integer"
},
"whisperVolume": {
"description": "Indicates whether the device volume was modified for whisper.",
"type": "string",
"enum": [
"ON",
"OFF"
]
},
"eventDate": {
"description": "The date when the entry was created.",
"type": "string",
"format": "date-time"
}
},
"required": [
"deviceSerialNumber",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "G123MW45678901A2",
"actualVolume": 50,
"whisperVolume": "ON",
"eventDate": "2024-04-16T19:20:21.999Z"
}
]
Echo Device Usage & Settings
This bucket includes information about customer device settings, events and statuses such as:
Echo engagement metrics
This scope includes device activity and setup information.
Identifiers:
- Login with Amazon Scope Name:
portability::echo_engagement_metrics
- Amazon Data Portability
scopeId
:portability-echo-engagement-metrics
Device Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type. | ECHO |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute representing the type of metric being measured. | appAction |
reasonCode |
What triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement",
"description": "Device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on a device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device"
},
"softwareVersion": {
"type": "string",
"description": "Device software version"
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "What triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "ECHO",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Application Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
appPackageName |
Package name of application for which metric is associated. | com.amazon.avod |
appVersionName |
Version of the application for which the metric is associated. | 5.7.3-17 |
appVersionCode |
Numeric value of the application version. | 573001710 |
deviceType |
Device type. | ECHO |
deviceProfileType |
Profile Type. | Adult |
appProfileType |
Type of App profile. | Adult |
launchCount |
Number of times app has been launched. | 7 |
durationMilliseconds |
Duration of app in use for the metric session in milliseconds. | 901141 |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
metricLevel |
Attribute representing the type of metric being measured. | appAction |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
reasonCode |
Describes context of metric. | VOICE_OFF |
metricSource |
Device source of metric. | APP |
startTime |
Timestamp when the app launched. | 2017-05-06 22:06:04.0 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "App Engagement",
"description": "Application usage data including device information and app metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"appPackageName": {
"type": "string",
"description": "Package name of application for which metric is associated."
},
"appVersionName": {
"type": "string",
"description": "Version of the application for which the metric is associated."
},
"appVersionCode": {
"type": "string",
"description": "Numeric value of the application version."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device Type"
},
"deviceProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Profile Type."
},
"appProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Type of App profile."
},
"launchCount": {
"type": "string",
"description": "Number of times app has been launched."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of app in use for the metric session in milliseconds."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
},
"metricSource": {
"type": "string",
"description": "Device source of metric."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the app launched."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"appPackageName": "com.amazon.avod",
"appVersionName": "5.7.3-17",
"appVersionCode": "573001710",
"deviceType": "ECHO",
"deviceProfileType": "Adult",
"appProfileType": "Adult",
"launchCount": "7",
"durationMilliseconds": "901141",
"softwareVersion": "36.5.7.3_user_573210520",
"metricLevel": "appAction",
"productMode": "SHOW_MODE",
"reasonCode": "VOICE_OFF",
"metricSource": "APP",
"startTime": "2017-05-06 22:06:04.0"
}
]
Third-party device usage data including device information and software detail
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device serial number. | 0094052161860CT8 |
deviceType |
Device type. | ECHO |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | DEFAULT |
metricLevel |
Attribute representing the type of metric being measured. | deviceAction |
reasonCode |
Describes context of metric. | VOICE_ON |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement 3p ACK",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "ECHO",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_ON"
}
]
Out Of Box Experience (OOBE) staging data including device and navigation details
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Device UTC timestamp at the time of recording the event. | 2021-01-08 04:25:53.0 |
deviceSerialNumber |
Device Serial Number. | G001DE4567890D6C |
deviceType |
Describes major device category. | ECHO |
osVersion |
Device Software Version. | 36.5.7.3_user_573210520 |
deviceSessionId |
Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS). | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSessionId |
App-level session ID, a unique "session" within the app itself. | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSequenceId |
App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1). | 1 |
appPackageName |
The app package name that corresponds to the OOBE step. | com.amazon.oobe |
appVersion |
App version or application used for Out Of Box Experience. | 1.0.207001.0_13065210 |
appProfileType |
Type of App profile. | Adult |
deviceProfile |
Device profile identifier. | com.amazon.oid.AZADASASASAS |
deviceProfileType |
Profile Type. | Adult |
fromPage |
The previous page_id. | OOBE |
toPage |
The next page_id after the current step. | Registration |
currentPage |
Page Name/ID to identify the page. | LanguagePicker |
metricName |
The metric event. | LanguagePickerModule_END |
sequenceId |
High level incrementing sequence id for out of box experience process. | 2 |
eventDurationMilliseconds |
The duration of the event. | 901141 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement Metrics",
"description": "Out Of Box Experience (OOBE) staging data including device and navigation details",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"metricName",
"currentPage",
"sequenceId",
"osVersion",
"appSessionId"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Device UTC timestamp at the time of recording the event."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Describes major device category."
},
"osVersion": {
"type": "string",
"description": "Device Software Version."
},
"deviceSessionId": {
"type": "string",
"description": "Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS)."
},
"appSessionId": {
"type": "string",
"description": "App-level session ID, a unique 'session' within the app itself."
},
"appSequenceId": {
"type": "string",
"description": "App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1)."
},
"appPackageName": {
"type": "string",
"description": "The app package name that corresponds to the OOBE step."
},
"appVersion": {
"type": "string",
"description": "App version or application used for Out Of Box Experience."
},
"appProfileType": {
"type": "string",
"description": "Type of App profile."
},
"deviceProfile": {
"type": "string",
"description": "Device profile identifier."
},
"deviceProfileType": {
"type": "string",
"description": "Profile Type."
},
"fromPage": {
"type": "string",
"description": "The previous page_id."
},
"toPage": {
"type": "string",
"description": "The next page_id after the current step."
},
"currentPage": {
"type": "string",
"description": "Page Name/ID to identify the page."
},
"metricName": {
"type": "string",
"description": "The metric event."
},
"sequenceId": {
"type": "string",
"description": "High level incrementing sequence id for out of box experience process."
},
"eventDurationMilliseconds": {
"type": "string",
"description": "The duration of the event."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2021-01-08 04:25:53.0",
"deviceSerialNumber": "G001DE4567890D6C",
"deviceType": "ECHO",
"osVersion": "36.5.7.3_user_573210520",
"deviceSessionId": "b7c498dc-c394-4d93-81ed-bbd9d5d4511d",
"appSessionId": "db5801e6-20f1-42b4-ac51-e3b1c4597da3",
"appSequenceId": "0",
"appPackageName": "com.amazon.oobe",
"appVersion": "1.0.207001.0_13065210",
"appProfileType": "Adult",
"deviceProfile": "com.amazon.oid.AZADASASASAS",
"deviceProfileType": "Adult",
"fromPage": "OOBE",
"toPage": "WiFi",
"currentPage": "LanguagePicker",
"metricName": "LanguagePickerModule_END",
"sequenceId": "1",
"eventDurationMilliseconds": "90114"
}
]
Total usage data including device information and usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device serial number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
startTime |
When the total usage event was started in timestamp format. | 2017-05-06 22:06:04.0 |
endTime |
When the total usage event was ended in timestamp format. | 2017-05-06 22:06:04.0 |
durationMilliseconds |
Duration of total_usage event in milliseconds. | 901141 |
metricName |
Device metric information. | TOTAL_USAGE |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
triggerType |
Describes context of total usage Metric, what triggered the metric. | SCREEN_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage",
"description": "Total usage data including device information and usage metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"durationMilliseconds",
"metricName",
"softwareVersion"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was started in timestamp format."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was ended in timestamp format."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of total_usage event in milliseconds."
},
"metricName": {
"type": "string",
"description": "Device metric information."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"triggerType": {
"type": "string",
"description": "Describes context of total usage Metric, what triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"startTime": "2017-05-06 22:06:04.0",
"endTime": "2017-05-06 22:06:04.0",
"durationMilliseconds": "901141",
"metricName": "TOTAL_USAGE",
"softwareVersion": "36.5.7.3_user_573210520",
"triggerType": "SCREEN_OFF"
}
]
Total usage rolled up to a per-user/per-device, per-day level
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The date that has been aggregated to for this set of metrics. | 2025-08-10T00:00:00Z |
deviceSerialNumber |
Device serial number. | 0094052161860CT8 |
deviceType |
Product category. | ECHO |
asin |
ASIN of the product. | B00KQO3EVM |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
durationMilliseconds |
Total amount of time for a specific metric on the day for the specific device serial number. | 901141 |
powerLossCount |
The number of times a customer powered off the device for the day. | 1 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage Per Day",
"description": "This table stores total usage rolled up to a per-user/per-device, per-day level.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"softwareVersion",
"durationMilliseconds"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date that has been aggregated to for this set of metrics."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Product category."
},
"asin": {
"type": "string",
"description": "ASIN of the product."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"durationMilliseconds": {
"type": "string",
"description": "Total amount of time for a specific metric on the day for the specific device serial number."
},
"powerLossCount": {
"type": "string",
"description": "The number of times a customer powered off the device for the day."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2025-08-10T00:00:00Z",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "ECHO",
"asin": "B00KQO3EVM",
"softwareVersion": "36.5.7.3_user_573210520",
"durationMilliseconds": "901141",
"powerLossCount": "1"
}
]
Echo groups
This scope includes customer's Echo device pairing configuration.
Identifiers:
- Login with Amazon Scope Name:
portability::echo_groups
- Amazon Data Portability
scopeId
:portability-echo-groups
Echo groups
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceMap |
Map of devices in customer household to device cluster prediction. | N/A |
deviceMap.deviceSerialNumber |
Device serial number. | GXX0MWR9WK0L50PA |
deviceMap.deviceType |
Device type friendly name. | Echo Dot (5th gen) |
deviceMap.deviceCluster |
Device cluster prediction - Each cluster is a group of devices that frequently activate together and are predicted to be in close physical proximity. | 1 |
deviceMap.deviceClusterConfidence |
Confidence of the device cluster prediction. | High Confidence |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Alexa Device Cluster",
"description": "Device cluster predictions for alexa endpoints in customer household",
"type": "object",
"properties": {
"deviceMap": {
"type": "array",
"description": "Map of devices in customer household to device cluster prediction",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number"
},
"deviceType": {
"type": "string",
"description": "Device type friendly name"
},
"deviceCluster": {
"type": "string",
"description": "Device cluster prediction - Each cluster is a group of devices that frequently activate together and are predicted to be in close physical proximity."
},
"deviceClusterConfidence": {
"type": "string",
"enum": [
"High Confidence",
"Medium Confidence",
"Low Confidence"
],
"description": "Confidence of the device cluster prediction"
}
},
"required": [
"deviceSerialNumber",
"deviceType",
"deviceCluster",
"deviceClusterConfidence"
],
"unevaluatedProperties": false
}
}
},
"required": [
"deviceMap"
],
"unevaluatedProperties": false
}
Sample data based on the sample schema:
[
{
"deviceMap": [
{
"deviceSerialNumber": "GXX0MWR9WK0L50PA",
"deviceType": "Echo Dot (5th gen)",
"deviceCluster": "1",
"deviceClusterConfidence": "High Confidence"
}
]
}
]
Echo location
This scope includes customer's Alexa accessory room arrangements.
Identifiers:
- Login with Amazon Scope Name:
portability::echo_location
- Amazon Data Portability
scopeId
:portability-echo-location
Echo location
Schema properties:
Properties | Details | Example value |
---|---|---|
sourceDeviceSerialNumber |
The device info of the source device. | GXX0SWETD131FUF2 |
accessoryDeviceSerialNumber |
The accessory linked with source device for location tracking. | G0G0UP089385008B |
accessoryLatitudeInDegrees |
The latitude of the accessory device. | 47.61837 |
accessoryLongitudeInDegrees |
The altitude of the accessory device. | -122.3537 |
accessoryCoordinateAccuracyInMeters |
The coordinate accuracy info of the accessory device. | 0 |
accessoryAltitudeInMeters |
The altitude of the accessory device. | 4.7 |
accessoryAltitudeAccuracyInMeters |
The altitude accuracy of the accessory device. | 0 |
accessorySpeedInMetersPerSecond |
The device speed of the accessory device. | 0 |
accessorySpeedAccuracyInMetersPerSecond |
The device speed accuracy of the accessory device. | 0 |
accessoryDirectionInDegrees |
The heading info in degrees of the accessory device. | 0 |
accessoryDirectionAccuracyInDegrees |
The heading info in degrees of the accessory device. | 0 |
nearbyDeviceNames |
The nearby Device names. | Echo Show |
proximity |
The estimated proximity info of neighbors. | 0 |
address |
The Address of the device. | 905 11th Ave |
eventDate |
The date when the event was generated. | 2022-03-08T12:51:20Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Last Known Location",
"description": "Includes the Geolocation info of device last known location",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceDeviceSerialNumber": {
"type": "string",
"description": "The device info of the source device."
},
"accessoryDeviceSerialNumber": {
"type": "string",
"description": "The accessory linked with source device for location tracking."
},
"accessoryLatitudeInDegrees": {
"type": "string",
"description": "The latitude of the accessory device."
},
"accessoryLongitudeInDegrees": {
"type": "string",
"description": "The altitude of the accessory device."
},
"accessoryCoordinateAccuracyInMeters": {
"type": "string",
"description": "The coordinate accuracy info of the accessory device."
},
"accessoryAltitudeInMeters": {
"type": "string",
"description": "The altitude of the accessory device."
},
"accessoryAltitudeAccuracyInMeters": {
"type": "string",
"description": "The altitude accuracy of the accessory device."
},
"accessorySpeedInMetersPerSecond": {
"type": "string",
"description": "The device speed of the accessory device."
},
"accessorySpeedAccuracyInMetersPerSecond": {
"type": "string",
"description": "The device speed accuracy of the accessory device."
},
"accessoryDirectionInDegrees": {
"type": "string",
"description": "The heading info in degrees of the accessory device."
},
"accessoryDirectionAccuracyInDegrees": {
"type": "string",
"description": "The heading info in degrees of the accessory device."
},
"nearbyDeviceNames": {
"type": "string",
"description": "The nearby Device names."
},
"proximity": {
"type": "string",
"description": "The estimated proximity info of neighbors."
},
"address": {
"type": "string",
"description": "The Address of the device."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the event was generated."
}
}
},
"required": [
"sourceDeviceSerialNumber",
"accessoryDeviceSerialNumber",
"accessoryLatitudeInDegrees",
"accessoryLongitudeInDegrees",
"accessoryCoordinateAccuracyInMeters",
"accessoryAltitudeInMeters",
"accessoryAltitudeAccuracyInMeters",
"accessorySpeedInMetersPerSecond",
"accessorySpeedAccuracyInMetersPerSecond",
"accessoryDirectionInDegrees",
"accessoryDirectionAccuracyInDegrees",
"nearbyDeviceNames",
"proximity",
"address",
"eventDate"
],
"unevaluatedProperties": false
}
Sample data based on the sample schema:
[
{
"sourceDeviceSerialNumber": "GXX0SWETD131FUF2",
"accessoryDeviceSerialNumber": "G0G0UP089385008B",
"accessoryLatitudeInDegrees": "47.61837",
"accessoryLongitudeInDegrees": "-122.3537",
"accessoryCoordinateAccuracyInMeters": "0",
"accessoryAltitudeInMeters": "4.7",
"accessoryAltitudeAccuracyInMeters": "0",
"accessorySpeedInMetersPerSecond": "0",
"accessorySpeedAccuracyInMetersPerSecond": "0",
"accessoryDirectionInDegrees": "0",
"accessoryDirectionAccuracyInDegrees": "0",
"nearbyDeviceNames": "Echo Show",
"proximity": "0",
"address": "905 11th Ave",
"eventDate": "2022-03-08T12:51:20Z"
}
]
Echo registrations
This scope includes device registration status.
Identifiers:
- Login with Amazon Scope Name:
portability::echo_registrations
- Amazon Data Portability
scopeId
:portability-echo-registrations
Echo registrations
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Unique serial number identifier for the Echo device. | 1115FB4AD4D10805 |
customerType |
Type of customer account - either adult or child account. | ADULT |
deviceAccountRole |
Role of the device in the account - primary or secondary device. | PRIMARY |
accountName |
Display name of the account associated with the device. | Anna's Android device |
firstTimeRegistered |
Timestamp when the device was first registered to an account. | 2025-08-21T07:03:23.310Z |
lastTimeRegistered |
Timestamp of the most recent registration event for the device. | 2025-08-21T07:03:23.310Z |
timeDeregistered |
Timestamp when the device was deregistered from the account, or 'Not Available' if still registered. | Not Available |
state |
Current operational state of the device registration. | ACTIVE |
currentFirmwareVersion |
Version number of the firmware currently installed on the device. | 2689890035 |
deviceModel |
Model identifier of the Echo device. | MicrosoftMDG_RM-1085_12742_Windows_phone |
localTimeOffset |
Time zone offset from UTC for the device's local time. | -8:00 |
ipAddress |
Last known IP address of the device. | 85.76.41.112 |
customerLoginPool |
Authentication pool used for customer login (e.g., Amazon, Enterprise). | Amazon |
devicePairingDetails |
List of device pairing configurations and their status. | N/A |
devicePairingDetails.protocol |
Communication protocol used for device pairing. | Bluetooth |
devicePairingDetails.status |
Current status of the pairing connection. | INACTIVE |
devicePairingDetails.autoPairEnabled |
Whether automatic pairing is enabled for this protocol. | FALSE |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Registration",
"description": "Device registration information of Echo devices.",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"type": "string",
"description": "Unique serial number identifier for the Echo device."
},
"customerType": {
"type": "string",
"enum": [
"ADULT",
"CHILD"
],
"description": "Type of customer account - either adult or child account."
},
"deviceAccountRole": {
"type": "string",
"enum": [
"PRIMARY",
"SECONDARY"
],
"description": "Role of the device in the account - primary or secondary device."
},
"accountName": {
"type": "string",
"description": "Display name of the account associated with the device."
},
"firstTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device was first registered to an account."
},
"lastTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the most recent registration event for the device."
},
"timeDeregistered": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Available"
}
],
"description": "Timestamp when the device was deregistered from the account, or 'Not Available' if still registered."
},
"state": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current operational state of the device registration."
},
"currentFirmwareVersion": {
"type": "string",
"description": "Version number of the firmware currently installed on the device."
},
"deviceModel": {
"type": "string",
"description": "Model identifier of the Echo device."
},
"localTimeOffset": {
"type": "string",
"description": "Time zone offset from UTC for the device's local time."
},
"ipAddress": {
"type": "string",
"description": "Last known IP address of the device."
},
"customerLoginPool": {
"type": "string",
"description": "Authentication pool used for customer login (e.g., Amazon, Enterprise)."
},
"devicePairingDetails": {
"type": "array",
"description": "List of device pairing configurations and their status.",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"description": "Communication protocol used for device pairing."
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current status of the pairing connection."
},
"autoPairEnabled": {
"type": "boolean",
"description": "Whether automatic pairing is enabled for this protocol."
}
},
"required": [
"protocol",
"status",
"autoPairEnabled"
],
"unevaluatedProperties": false
}
}
},
"required": [
"deviceSerialNumber",
"customerType",
"deviceAccountRole",
"accountName",
"firstTimeRegistered",
"lastTimeRegistered",
"timeDeregistered",
"state",
"currentFirmwareVersion",
"deviceModel",
"localTimeOffset",
"ipAddress",
"customerLoginPool"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "1115FB4AD4D10805",
"customerType": "ADULT",
"deviceAccountRole": "PRIMARY",
"accountName": "Anna's Android device",
"firstTimeRegistered": "2025-08-21T07:03:23.310Z",
"lastTimeRegistered": "2025-08-21T07:03:23.310Z",
"timeDeregistered": "Not Available",
"state": "ACTIVE",
"currentFirmwareVersion": "2689890035",
"deviceModel": "MicrosoftMDG_RM-1085_12742_Windows_phone",
"localTimeOffset": "-8:00",
"ipAddress": "85.76.41.112",
"customerLoginPool": "Amazon",
"devicePairingDetails": {
"protocol": "Bluetooth",
"status": "INACTIVE",
"autoPairEnabled": false
}
}
]
Echo screen sharing targets
This scope includes customer's screen sharing preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::echo_screen_sharing_targets
- Amazon Data Portability
scopeId
:portability-echo-screen-sharing-targets
Echo screen sharing targets
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The UTC timestamp when this record was created. | 1970-01-01T00:00:00Z |
deviceSerialNumber |
The Amazon serial number for the device. | G000RA0583640F99 |
softwareVersion |
The version of the Screen sharing app on the customer's device that registered. | 1.0 |
Sample schema:
{
"$schema": "http://json-schema.org/draft/2020-12/schema",
"title": "Mayday Screen Sharing - Device Registrations",
"description": "DeviceRegistration records are used to identify the customer device to which a screen sharing invitation will be sent.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"softwareVersion"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"default": "1970-01-01T00:00:00Z",
"description": "The UTC timestamp when this record was created."
},
"deviceSerialNumber": {
"type": "string",
"default": "DeviceSerialNumber",
"description": "The Amazon serial number for the device."
},
"softwareVersion": {
"type": "string",
"default": "1.0",
"description": "The version of the Screen sharing app on the customer's device that registered."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "1970-01-01T00:00:00Z",
"deviceSerialNumber": "G000RA0583640F99",
"softwareVersion": "1.0"
}
]
Echo setup connections
This scope includes customer's device privacy preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::echo_setup_connections
- Amazon Data Portability
scopeId
:portability-echo-setup-connections
Echo setup connections
Schema properties:
Properties | Details | Example value |
---|---|---|
provisionerDeviceType |
Provisioner device type id. | ECHO |
provisionerDeviceModel |
Provisioner reported Model. | AFTEU011 |
provisionerFirmwareVersion |
Provisioner reported Firmware version. | 15.5 |
endTime |
Furthest events time stamp/Session End time. | 2017-05-06 22:06:04.0 |
provisioneeZigbeeMacAddress |
Provisionee Zigbee MAC Address. | 00:17:88:01:XX:XX:XX:XX |
provisioneeWifiMacAddress |
Provisionee Wi-Fi MAC Address. | null |
eventDate |
Earliest events time stamp/Session start time. | 2017-05-06 22:06:04.0 |
chosenSsidCredentialsChanged |
Indicates if the customer modified the credentials of pre-populated network credentials. | Yes |
provisioneeDeviceName |
Provisionee reported device name. | Echo Dot-W0J |
provisioneeDeviceModel |
Provisionee reported model. | A3VRME03NAXFUB |
deviceSerialNumber |
Provisionee provided Device Serial Number. | xxxLF1071771JPX |
provisioneeHardwareVersion |
Provisionee reported hardware version. | mt8169 |
provisioneeFriendlyName |
Device friendly name. | null |
provisioneeFirmwareVersion |
Provisionee reported firmware version. | 7.1.2 |
provisioneeBLEMacAddress |
Provisionee BLE MAC address. | C3:A4:D2:D8:DD:DA |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Setup Connections",
"description": "Schema for devices Frustration free set up session details.",
"type": "array",
"items": {
"type": "object",
"required": [
"provisionerDeviceType",
"endTime",
"eventDate",
"deviceSerialNumber"
],
"unevaluatedProperties": false,
"properties": {
"provisionerDeviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Provisioner device type id."
},
"provisionerDeviceModel": {
"type": "string",
"description": "Provisioner reported Model."
},
"provisionerFirmwareVersion": {
"type": "string",
"description": "Provisioner reported Firmware version."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Furthest events time stamp/Session End time."
},
"provisioneeZigbeeMacAddress": {
"type": "string",
"description": "Provisionee Zigbee MAC Address."
},
"provisioneeWifiMacAddress": {
"type": "string",
"description": "Provisionee Wi-Fi MAC Address."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Earliest events time stamp/Session start time"
},
"chosenSsidCredentialsChanged": {
"type": "string",
"enum": [
"Yes",
"No",
"Not Available"
],
"description": "Indicates if the customer modified the credentials of pre-populated network credentials."
},
"provisioneeDeviceName": {
"type": "string",
"description": "Provisionee reported device name."
},
"provisioneeDeviceModel": {
"type": "string",
"description": "Provisionee reported model."
},
"deviceSerialNumber": {
"type": "string",
"description": "Provisionee provided Device Serial Number."
},
"provisioneeHardwareVersion": {
"type": "string",
"description": "Provisionee reported hardware version."
},
"provisioneeFriendlyName": {
"type": "string",
"description": "Device friendly name."
},
"provisioneeFirmwareVersion": {
"type": "string",
"description": "Provisionee reported firmware version."
},
"provisioneeBLEMacAddress": {
"type": "string",
"description": "Provisionee BLE MAC address."
}
}
}
}
Sample data based on the sample schema:
[
{
"provisionerDeviceType": "ECHO",
"provisionerDeviceModel": "AFTEU011",
"provisionerFirmwareVersion": "15.5",
"endTime": "2017-05-06 22:06:04.0",
"provisioneeZigbeeMacAddress": "00:17:88:01:XX:XX:XX:XX",
"provisioneeWifiMacAddress": null,
"eventDate": "2017-05-06 22:06:04.0",
"chosenSsidCredentialsChanged": "Yes",
"provisioneeDeviceName": "Echo Dot-W0J",
"provisioneeDeviceModel": "A3VRME03NAXFUB",
"deviceSerialNumber": "xxxLF1071771JPX",
"provisioneeHardwareVersion": "mt8169",
"provisioneeFriendlyName": null,
"provisioneeFirmwareVersion": "7.1.2",
"provisioneeBLEMacAddress": "C3:A4:D2:D8:DD:DA"
}
]
Echo usage metrics
This scope includes customer's customized device settings.
Identifiers:
- Login with Amazon Scope Name:
portability::echo_usage_metrics
- Amazon Data Portability
scopeId
:portability-echo-usage-metrics
Echo usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number | 0094052161860CT8 |
deviceType |
Device type determines the internal identifier for launched device. | ECHO |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute Inherited from Clickstream. | appAction |
reasonCode |
Describes context of DEM Metric, what triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Usage 3P",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on a device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type determines the internal identifier for launched device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute Inherited from Clickstream."
},
"reasonCode": {
"type": "string",
"description": "Describes context of DEM Metric, what triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "ECHO",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Fire Tablet Device Usage and Settings
This bucket includes information about how you use your Fire Tablet, its settings, and accessories, such as:
Fire tablet backup overview
This scope includes customer's tablet backup information.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_backup_overview
- Amazon Data Portability
scopeId
:portability-fire-tablet-backup-overview
Fire tablet backup overview
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceBackups |
Fire tablet device's backups. | N/A |
deviceBackups.deviceName |
Name of the Fire tablet device. | Teja's Fire |
deviceBackups.lastBackupTime |
Timestamp of the last backup. | 2023-08-10T08:55:59.103Z |
deviceBackups.deviceSerialNumber |
Unique serial number of the device. | GCC21U021373006N |
deviceBackups.eventDate |
Timestamp when the backup was created. | 2021-09-29T11:04:43.305Z |
deviceBackups.packages |
Device backups' packages. | N/A |
deviceBackups.packages.packageName |
Name of the package/application. | com.amazon.cloud9 |
deviceBackups.packages.packageSize |
Size of the package in bytes. | 104448 |
deviceBackups.packages.packageBackupTime |
Timestamp when the package was backed up. | 2023-08-10T08:55:41.803Z |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Fire Tablets Backup And Restore Schema",
"description": "Schema for Fire tablet backup and restore data",
"unevaluatedProperties": false,
"properties": {
"deviceBackups": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"unevaluatedProperties": false,
"properties": {
"deviceName": {
"type": "string",
"description": "Name of the Fire tablet device"
},
"lastBackupTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the last backup"
},
"deviceSerialNumber": {
"type": "string",
"description": "Unique serial number of the device"
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the backup was created"
},
"packages": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"unevaluatedProperties": false,
"properties": {
"packageName": {
"type": "string",
"description": "Name of the package/application"
},
"packageSize": {
"type": "integer",
"description": "Size of the package in bytes"
},
"packageBackupTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the package was backed up"
}
},
"required": [
"packageName",
"packageSize",
"packageBackupTime"
]
}
}
},
"required": [
"deviceName",
"lastBackupTime",
"deviceSerialNumber",
"eventDate",
"packages"
]
}
}
},
"required": [
"deviceBackups"
]
}
Sample data based on the sample schema:
{
"deviceBackups": [
{
"deviceName": "Teja's Fire",
"lastBackupTime": "2023-08-10T08:55:59.103Z",
"deviceSerialNumber": "GCC21U021373006N",
"eventDate": "2021-09-29T11:04:43.305Z",
"packages": [
{
"packageName": "com.amazon.cloud9",
"packageSize": 104448,
"packageBackupTime": "2023-08-10T08:55:41.803Z"
}
]
}
]
}
Fire tablet engagement metrics
This scope includes customer's device activity and setup information.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_engagement_metrics
- Amazon Data Portability
scopeId
:portability-fire-tablet-engagement-metrics
Device Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type. | FIRE TABLETS |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute representing the type of metric being measured. | appAction |
reasonCode |
What triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement",
"description": "Device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on a device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device"
},
"softwareVersion": {
"type": "string",
"description": "Device software version"
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "What triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRE TABLETS",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Application Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
appPackageName |
Package name of application for which metric is associated. | com.amazon.avod |
appVersionName |
Version of the application for which the metric is associated. | 5.7.3-17 |
appVersionCode |
Numeric value of the application version. | 573001710 |
deviceType |
Device type. | FIRE TABLETS |
deviceProfileType |
Profile Type. | Adult |
appProfileType |
Type of App profile. | Adult |
launchCount |
Number of times app has been launched. | 7 |
durationMilliseconds |
Duration of app in use for the metric session in milliseconds. | 901141 |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
metricLevel |
Attribute representing the type of metric being measured. | appAction |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
reasonCode |
Describes context of metric. | VOICE_OFF |
metricSource |
Device source of metric. | APP |
startTime |
Timestamp when the app launched. | 2017-05-06 22:06:04.0 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "App Engagement",
"description": "Application usage data including device information and app metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"appPackageName": {
"type": "string",
"description": "Package name of application for which metric is associated."
},
"appVersionName": {
"type": "string",
"description": "Version of the application for which the metric is associated."
},
"appVersionCode": {
"type": "string",
"description": "Numeric value of the application version."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device Type"
},
"deviceProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Profile Type."
},
"appProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Type of App profile."
},
"launchCount": {
"type": "string",
"description": "Number of times app has been launched."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of app in use for the metric session in milliseconds."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
},
"metricSource": {
"type": "string",
"description": "Device source of metric."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the app launched."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"appPackageName": "com.amazon.avod",
"appVersionName": "5.7.3-17",
"appVersionCode": "573001710",
"deviceType": "FIRE TABLETS",
"deviceProfileType": "Adult",
"appProfileType": "Adult",
"launchCount": "7",
"durationMilliseconds": "901141",
"softwareVersion": "36.5.7.3_user_573210520",
"metricLevel": "appAction",
"productMode": "SHOW_MODE",
"reasonCode": "VOICE_OFF",
"metricSource": "APP",
"startTime": "2017-05-06 22:06:04.0"
}
]
Third-party device usage data including device information and software details
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type. | FIRE TABLETS |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | DEFAULT |
metricLevel |
Attribute representing the type of metric being measured. | deviceAction |
reasonCode |
Describes context of metric. | VOICE_ON |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement 3p ACK",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRE TABLETS",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_ON"
}
]
Out Of Box Experience (OOBE) staging data including device and navigation details
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Device UTC timestamp at the time of recording the event. | 2021-01-08 04:25:53.0 |
deviceSerialNumber |
Device Serial Number. | G001DE4567890D6C |
deviceType |
Describes major device category. | FIRE TABLETS |
osVersion |
Device Software Version. | 36.5.7.3_user_573210520 |
deviceSessionId |
Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS). | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSessionId |
App-level session ID, a unique "session" within the app itself. | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSequenceId |
App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1). | 1 |
appPackageName |
The app package name that corresponds to the OOBE step. | com.amazon.oobe |
appVersion |
App version or application used for Out Of Box Experience. | 1.0.207001.0_13065210 |
appProfileType |
Type of App profile. | Adult |
deviceProfile |
Device profile identifier. | Device profile identifier. |
deviceProfileType |
Profile Type. | Adult |
fromPage |
The previous page_id. | OOBE |
toPage |
The next page_id after the current step . | Registration |
currentPage |
Page Name/ID to identify the page. | LanguagePicker |
metricName |
The metric event. | LanguagePickerModule_END |
sequenceId |
High level incrementing sequence id for out of box experience process. | 2 |
eventDurationMilliseconds |
The duration of the event. | 901141 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement Metrics",
"description": "Out Of Box Experience (OOBE) staging data including device and navigation details",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"metricName",
"currentPage",
"sequenceId",
"osVersion",
"appSessionId"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Device UTC timestamp at the time of recording the event."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Describes major device category."
},
"osVersion": {
"type": "string",
"description": "Device Software Version."
},
"deviceSessionId": {
"type": "string",
"description": "Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS)."
},
"appSessionId": {
"type": "string",
"description": "App-level session ID, a unique 'session' within the app itself."
},
"appSequenceId": {
"type": "string",
"description": "App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1)."
},
"appPackageName": {
"type": "string",
"description": "The app package name that corresponds to the OOBE step."
},
"appVersion": {
"type": "string",
"description": "App version or application used for Out Of Box Experience."
},
"appProfileType": {
"type": "string",
"description": "Type of App profile."
},
"deviceProfile": {
"type": "string",
"description": "Device profile identifier."
},
"deviceProfileType": {
"type": "string",
"description": "Profile Type."
},
"fromPage": {
"type": "string",
"description": "The previous page_id."
},
"toPage": {
"type": "string",
"description": "The next page_id after the current step."
},
"currentPage": {
"type": "string",
"description": "Page Name/ID to identify the page."
},
"metricName": {
"type": "string",
"description": "The metric event."
},
"sequenceId": {
"type": "string",
"description": "High level incrementing sequence id for out of box experience process."
},
"eventDurationMilliseconds": {
"type": "string",
"description": "The duration of the event."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2021-01-08 04:25:53.0",
"deviceSerialNumber": "G001DE4567890D6C",
"deviceType": "FIRE TABLETS",
"osVersion": "36.5.7.3_user_573210520",
"deviceSessionId": "b7c498dc-c394-4d93-81ed-bbd9d5d4511d",
"appSessionId": "db5801e6-20f1-42b4-ac51-e3b1c4597da3",
"appSequenceId": "0",
"appPackageName": "com.amazon.oobe",
"appVersion": "1.0.207001.0_13065210",
"appProfileType": "Adult",
"deviceProfile": "com.amazon.oid.AZADASASASAS",
"deviceProfileType": "Adult",
"fromPage": "OOBE",
"toPage": "WiFi",
"currentPage": "LanguagePicker",
"metricName": "LanguagePickerModule_END",
"sequenceId": "1",
"eventDurationMilliseconds": "90114"
}
]
Total usage data including device information and usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
startTime |
When the total usage event was started in timestamp format. | 2017-05-06 22:06:04.0 |
endTime |
When the total usage event was ended in timestamp format. | 2017-05-06 22:06:04.0 |
durationMilliseconds |
Duration of total_usage event in milliseconds. | 901141 |
metricName |
Device metric information. | TOTAL_USAGE |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
triggerType |
Describes context of total usage Metric, what triggered the metric. | SCREEN_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage",
"description": "Total usage data including device information and usage metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"durationMilliseconds",
"metricName",
"softwareVersion"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was started in timestamp format."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was ended in timestamp format."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of total_usage event in milliseconds."
},
"metricName": {
"type": "string",
"description": "Device metric information."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"triggerType": {
"type": "string",
"description": "Describes context of total usage Metric, what triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"startTime": "2017-05-06 22:06:04.0",
"endTime": "2017-05-06 22:06:04.0",
"durationMilliseconds": "901141",
"metricName": "TOTAL_USAGE",
"softwareVersion": "36.5.7.3_user_573210520",
"triggerType": "SCREEN_OFF"
}
]
Total usage data for each user, device, and day
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The date that has been aggregated to for this set of metrics. | 2025-08-10T00:00:00Z |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Product category. | FIRE TABLETS |
asin |
ASIN of the product. | B00KQO3EVM |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
durationMilliseconds |
Total amount of time for a specific metric on the day for the specific device serial number. | 901141 |
powerLossCount |
The number of times a customer powered off the device for the day. | 1 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage Per Day",
"description": "This table stores total usage rolled up to a per-user/per-device, per-day level.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"softwareVersion",
"durationMilliseconds"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date that has been aggregated to for this set of metrics."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Product category."
},
"asin": {
"type": "string",
"description": "ASIN of the product."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"durationMilliseconds": {
"type": "string",
"description": "Total amount of time for a specific metric on the day for the specific device serial number."
},
"powerLossCount": {
"type": "string",
"description": "The number of times a customer powered off the device for the day."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2025-08-10T00:00:00Z",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRE TABLETS",
"asin": "B00KQO3EVM",
"softwareVersion": "36.5.7.3_user_573210520",
"durationMilliseconds": "901141",
"powerLossCount": "1"
}
]
Fire tablet framework metrics
This scope includes customer's writing, typing and stylus usage.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_framework_metrics
- Amazon Data Portability
scopeId
:portability-fire-tablet-framework-metrics
Tablet Keyboard Usage Metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Timestamp when the device recorded the metric. | 2023-05-30T11:01:17Z |
metricKey |
Keyboard product name used with the tablet. | Fire Max 11 Keyboard Case |
metricType |
Category of the metric emitted. | KeyboardUsageMetrics |
softwareVersion |
Software version of the OS installed on the device. | 0027246935172 |
deviceSerialNumber |
Device Serial Number. | GCC2DM04314300WX |
metricValue |
Duration of active keyboard usage in milliseconds. | 30056 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Tablet Keyboard Usage Metrics",
"description": "Includes usage metrics for Keyboards on Tablet devices.",
"type": "array",
"items": {
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"metricKey",
"metricType",
"softwareVersion",
"deviceSerialNumber",
"metricValue"
],
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device recorded the metric."
},
"metricKey": {
"type": "string",
"description": "Keyboard product name used with the tablet."
},
"metricType": {
"type": "string",
"description": "Category of the metric emitted."
},
"softwareVersion": {
"type": "string",
"description": "Software version of the OS installed on the device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"metricValue": {
"type": "integer",
"description": "Duration of active keyboard usage in milliseconds."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2023-05-30T11:01:17Z",
"metricKey": "Fire Max 11 Keyboard Case",
"metricType": "KeyboardUsageMetrics",
"softwareVersion": "0027246935172",
"deviceSerialNumber": "GCC2DM04314300WX",
"metricValue": 30056
}
]
Stylus Battery Metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Timestamp when the device recorded the metric. | 2023-05-30T11:01:17Z |
softwareVersion |
Software version of the OS installed on the device. | 0027246935172 |
productName |
Model of the device. | Fire HD 10 |
timezone |
Timezone of the device. | America/Los_Angeles |
deviceLanguage |
Language setting of the device. | en |
countryOfResidence |
Country of residence for the device user. | US |
deviceSerialNumber |
Device Serial Number. | GCC2DM04314300WX |
metricType |
Category of the metric emitted. | Stylus Battery Usage |
metricKey |
Unique key identifying the specific metric. | Battery Level |
metricValue |
Value of the metric. | 88 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Stylus Battery Metrics",
"description": "Includes details about Stylus Battery.",
"type": "array",
"items": {
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"softwareVersion",
"productName",
"timezone",
"deviceLanguage",
"Country",
"deviceSerialNumber",
"metricType",
"metricKey",
"metricValue"
],
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device recorded the metric."
},
"softwareVersion": {
"type": "string",
"description": "Software version of the OS installed on the device."
},
"productName": {
"type": "string",
"description": "Model of the device."
},
"timezone": {
"type": "string",
"description": "Timezone of the device."
},
"deviceLanguage": {
"type": "string",
"description": "Language setting of the device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence for the device user."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"metricType": {
"type": "string",
"description": "Category of the metric emitted."
},
"metricKey": {
"type": "string",
"description": "Unique key identifying the specific metric."
},
"metricValue": {
"type": "integer",
"description": "Value of the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2023-05-30T11:01:17Z",
"softwareVersion": "0027246935172",
"productName": "Fire HD 10",
"timezone": "America/Los_Angeles",
"deviceLanguage": "en",
"countryOfResidence": "US",
"deviceSerialNumber": "GCC2DM04314300WX",
"metricType": "Stylus Battery Usage",
"metricKey": "Battery Level",
"metricValue": 88
}
]
Handwriting Recognition Usage
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Timestamp when the device recorded the metric. | 2023-05-30T11:01:17Z |
softwareVersion |
Software version of the OS installed on the device. | 0027246935172 |
productName |
Model of the device. | Fire HD 10 |
deviceType |
Device Type. | Tablet |
timezone |
Timezone of the device. | America/Los_Angeles |
deviceLanguage |
Language setting of the device. | en |
countryOfResidence |
Country of residence for the device user. | United States |
deviceSerialNumber |
Device Serial Number. | GCC2DM04314300WX |
count |
Number of times Handwriting Recognition feature used. | 4 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Handwriting Recognition Usage",
"description": "Includes details about Handwriting Recognition feature usage on tablet devices.",
"type": "array",
"items": {
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"softwareVersion",
"productName",
"deviceType",
"timezone",
"deviceLanguage",
"countryOfResidence",
"deviceSerialNumber",
"count"
],
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device recorded the metric."
},
"softwareVersion": {
"type": "string",
"description": "Software version of the OS installed on the device."
},
"productName": {
"type": "string",
"description": "Model of the device."
},
"deviceType": {
"type": "string",
"description": "Device Type."
},
"timezone": {
"type": "string",
"description": "Timezone of the device."
},
"deviceLanguage": {
"type": "string",
"description": "Language setting of the device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence for the device user."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"count": {
"type": "integer",
"description": "Number of times Handwriting Recognition feature used."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2023-05-30T11:01:17Z",
"softwareVersion": "0027246935172",
"productName": "Fire HD 10",
"deviceType": "Tablet",
"timezone": "America/Los_Angeles",
"deviceLanguage": "en",
"countryOfResidence": "United States",
"deviceSerialNumber": "GCC2DM04314300WX",
"count": 4
}
]
Tablet Shortcut Key Metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Timestamp when the device recorded the metric. | 2023-05-30T11:01:17Z |
softwareVersion |
Software version of the OS installed on the device. | 0027246935172 |
productName |
Model of the device. | Fire HD 10 |
deviceType |
Device Type. | Tablet |
timezone |
Timezone of the device. | America/Los_Angeles |
deviceLanguage |
Language setting of the device. | en |
countryOfResidence |
Country of residence for the device user. | United States |
deviceSerialNumber |
Device Serial Number. | GCC2DM04314300WX |
vendorId |
Vendor ID of the keyboard. | Fire Max 11 Keyboard Case |
productId |
Product ID of the keyboard. | Fire Max 11 Keyboard Case |
metricType |
Category of the metric emitted. | ShortcutKeyCount |
metricKey |
Unique key identifying the specific shortcut key. | KEYCODE_VOLUME_UP |
count |
Number of times the shortcut key was pressed. | 88 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Tablet Shortcut Key Metrics",
"description": "Includes details about shortcut key usage metrics on tablet devices.",
"type": "array",
"items": {
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"softwareVersion",
"productName",
"deviceType",
"timezone",
"deviceLanguage",
"countryOfResidence",
"deviceSerialNumber",
"vendorId",
"productId",
"metricType",
"metricKey",
"count"
],
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device recorded the metric."
},
"softwareVersion": {
"type": "string",
"description": "Software version of the OS installed on the device."
},
"productName": {
"type": "string",
"description": "Model of the device."
},
"deviceType": {
"type": "string",
"description": "Device Type."
},
"timezone": {
"type": "string",
"description": "Timezone of the device."
},
"deviceLanguage": {
"type": "string",
"description": "Language setting of the device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence for the device user."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"vendorId": {
"type": "string",
"description": "Vendor ID of the keyboard."
},
"productId": {
"type": "string",
"description": "Product ID of the keyboard."
},
"metricType": {
"type": "string",
"description": "Category of the metric emitted."
},
"metricKey": {
"type": "string",
"description": "Unique key identifying the specific shortcut key."
},
"count": {
"type": "integer",
"description": "Number of times the shortcut key was pressed."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2023-05-30T11:01:17Z",
"softwareVersion": "0027246935172",
"productName": "Fire HD 10",
"deviceType": "Tablet",
"timezone": "America/Los_Angeles",
"deviceLanguage": "en",
"countryOfResidence": "United States",
"deviceSerialNumber": "GCC2DM04314300WX",
"vendorId": "Fire Max 11 Keyboard Case",
"productId": "Fire Max 11 Keyboard Case",
"metricType": "ShortcutKeyCount",
"metricKey": "KEYCODE_VOLUME_UP",
"count": 88
}
]
Tablet Fingerprint Usage
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Timestamp when the device recorded the metric. | 2023-05-30T11:01:17Z |
softwareVersion |
Software version of the OS installed on the device. | 0027246935172 |
productName |
Model of the device. | Fire HD 10 |
deviceType |
Device Type. | Tablet |
timezone |
Timezone of the device. | America/Los_Angeles |
deviceLanguage |
Language setting of the device. | en |
countryOfResidence |
Country of residence for the device user. | United States |
deviceSerialNumber |
Device Serial Number. | GCC2DM04314300WX |
fingerprintStatus |
Status of fingerprint authentication. | authentication_failure |
appName |
Name of the package using fingerprint authentication. | Zoom |
count |
Number of fingerprint authentication attempts. | 1 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Tablet Fingerprint Usage",
"description": "Includes details about fingerprint authentication usage on tablet devices.",
"type": "array",
"items": {
"type": "object",
"unevaluatedProperties": false,
"required": [
"eventDate",
"softwareVersion",
"productName",
"deviceType",
"timezone",
"deviceLanguage",
"countryOfResidence",
"deviceSerialNumber",
"fingerprintStatus",
"appName",
"count"
],
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device recorded the metric."
},
"softwareVersion": {
"type": "string",
"description": "Software version of the OS installed on the device."
},
"productName": {
"type": "string",
"description": "Model of the device."
},
"deviceType": {
"type": "string",
"description": "Device Type."
},
"timezone": {
"type": "string",
"description": "Timezone of the device."
},
"deviceLanguage": {
"type": "string",
"description": "Language setting of the device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence for the device user."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"fingerprintStatus": {
"type": "string",
"description": "Status of fingerprint authentication."
},
"appName": {
"type": "string",
"description": "Name of the package using fingerprint authentication."
},
"count": {
"type": "integer",
"description": "Number of fingerprint authentication attempts."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2023-05-30T11:01:17Z",
"softwareVersion": "0027246935172",
"productName": "Fire HD 10",
"deviceType": "Tablet",
"timezone": "America/Los_Angeles",
"deviceLanguage": "en",
"countryOfResidence": "United States",
"deviceSerialNumber": "GCC2DM04314300WX",
"fingerprintStatus": "authentication_failure",
"appName": "Zoom",
"count": 1
}
]
Fire tablet input metrics
This scope includes metrics on how the customer set up different ways to input information.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_input_metrics
- Amazon Data Portability
scopeId
:portability-fire-tablet-input-metrics
Fire tablet input metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
activeStylus |
Active stylus is used or not for handwriting on the tablet. | true |
model |
The model number of the device that made the record. | KFTUWI |
application |
The application package name which is used for handwriting. | Facebook |
countryOfResidence |
The country of residence of the tablet user. | United States |
deviceLanguageCode |
The device language set in the tablet settings. | en-US |
eventDate |
The metrics data record time in UTC format. | 2024-04-30T15:23:33.220Z |
deviceSerialNumber |
The tablet serial number used for handwriting. | GN434J0233540LTL |
deviceType |
The type of tablet making the record. | Fire HD 10 |
handwritingLanguage |
The language of keyboard which is used for handwriting which may be different with device language. | en-US |
handwritingLayoutMode |
The keyboard layout type of handwriting which is any of the following - writingPad, directWrite, alpha or split. | writingPad |
handwritingInOOBE |
Handwriting is used during tablet setup or not. | false |
softwareVersion |
The software version of the tablet used for handwriting. | 26441592452 |
timeZone |
The time zone where the record was generated. | America/Chicago |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Handwriting metrics",
"description": "Handwriting related metrics on Fire tablet",
"type": "array",
"items": {
"type": "object",
"properties": {
"activeStylus": {
"description": "Active stylus is used or not for handwriting on the tablet.",
"type": "boolean"
},
"model": {
"description": "The model number of the device that made the record.",
"type": "string"
},
"application": {
"description": "The application package name which is used for handwriting.",
"type": "string"
},
"countryOfResidence": {
"description": "The country of residence of the tablet user.",
"type": "string"
},
"deviceLanguageCode": {
"description": "The device language set in the tablet settings.",
"type": "string"
},
"eventDate": {
"description": "The metrics data record time in UTC format.",
"format": "date-time",
"type": "string"
},
"deviceSerialNumber": {
"description": "The tablet serial number used for handwriting.",
"type": "string"
},
"deviceType": {
"description": "The type of tablet making the record.",
"type": "string"
},
"handwritingLanguage": {
"description": "The language of keyboard which is used for handwriting which may be different with device language.",
"type": "string"
},
"handwritingLayoutMode": {
"description": "The keyboard layout type of handwriting which is any of the following - writingPad, directWrite, alpha or split.",
"type": "string",
"enum": [
"writingPad",
"directWrite",
"alpha",
"split"
]
},
"handwritingInOOBE": {
"description": "Handwriting is used during tablet setup or not.",
"type": "boolean"
},
"softwareVersion": {
"description": "The software version of the tablet used for handwriting.",
"type": "string"
},
"timeZone": {
"description": "The time zone where the record was generated.",
"type": "string"
}
},
"required": [
"eventDate",
"softwareVersion",
"model",
"deviceType",
"timeZone",
"countryOfResidence",
"deviceLanguageCode",
"deviceSerialNumber",
"handwritingLanguage",
"handwritingLayoutMode",
"activeStylus",
"handwritingInOOBE"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"activeStylus": true,
"model": "KFTUWI",
"application": "Facebook",
"countryOfResidence": "United States",
"deviceLanguageCode": "en-US",
"eventDate": "2024-04-30T15:23:33.220Z",
"deviceSerialNumber": "GN434J0233540LTL",
"deviceType": "Fire HD 10",
"handwritingLanguage": "en-US",
"handwritingLayoutMode": "writingPad",
"handwritingInOOBE": false,
"softwareVersion": "26441592452",
"timeZone": "America/Chicago"
}
]
Fire tablet registrations
This scope includes device registration status.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_registrations
- Amazon Data Portability
scopeId
:portability-fire-tablet-registrations
Fire tablet registrations
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Unique serial number identifier for the FireTablet device. | 1115FB4AD4D10805 |
customerType |
Type of customer account - either adult or child account. | ADULT |
deviceAccountRole |
Role of the device in the account - primary or secondary device. | PRIMARY |
accountName |
Display name of the account associated with the device. | Anna's Android device |
firstTimeRegistered |
Timestamp when the device was first registered to an account. | 2025-08-21T07:03:23.310Z |
lastTimeRegistered |
Timestamp of the most recent registration event for the device. | 2025-08-21T07:03:23.310Z |
timeDeregistered |
Timestamp when the device was deregistered from the account, or 'Not Available' if still registered. | Not Available |
state |
Current operational state of the device registration. | ACTIVE |
currentFirmwareVersion |
Version number of the firmware currently installed on the device. | 2689890035 |
deviceModel |
Model identifier of the FireTablet device. | MicrosoftMDG_RM-1085_12742_Windows_phone |
localTimeOffset |
Time zone offset from UTC for the device's local time. | -8:00 |
ipAddress |
Last known IP address of the device. | 85.76.41.112 |
customerLoginPool |
Authentication pool used for customer login (e.g., Amazon, Enterprise). | Amazon |
devicePairingDetails |
List of device pairing configurations and their status.. | N/A |
devicePairingDetails.protocol |
Communication protocol used for device pairing. | Bluetooth |
devicePairingDetails.status |
Current status of the pairing connection. | INACTIVE |
devicePairingDetails.autoPairEnabled |
Whether automatic pairing is enabled for this protocol. | false |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Registration",
"description": "Device registration information of FireTablet devices.",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"type": "string",
"description": "Unique serial number identifier for the FireTablet device."
},
"customerType": {
"type": "string",
"enum": [
"ADULT",
"CHILD"
],
"description": "Type of customer account - either adult or child account."
},
"deviceAccountRole": {
"type": "string",
"enum": [
"PRIMARY",
"SECONDARY"
],
"description": "Role of the device in the account - primary or secondary device."
},
"accountName": {
"type": "string",
"description": "Display name of the account associated with the device."
},
"firstTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device was first registered to an account."
},
"lastTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the most recent registration event for the device."
},
"timeDeregistered": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Available"
}
],
"description": "Timestamp when the device was deregistered from the account, or 'Not Available' if still registered."
},
"state": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current operational state of the device registration."
},
"currentFirmwareVersion": {
"type": "string",
"description": "Version number of the firmware currently installed on the device."
},
"deviceModel": {
"type": "string",
"description": "Model identifier of the FireTablet device."
},
"localTimeOffset": {
"type": "string",
"description": "Time zone offset from UTC for the device's local time."
},
"ipAddress": {
"type": "string",
"description": "Last known IP address of the device."
},
"customerLoginPool": {
"type": "string",
"description": "Authentication pool used for customer login (e.g., Amazon, Enterprise)."
},
"devicePairingDetails": {
"type": "array",
"description": "List of device pairing configurations and their status.",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"description": "Communication protocol used for device pairing."
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current status of the pairing connection."
},
"autoPairEnabled": {
"type": "boolean",
"description": "Whether automatic pairing is enabled for this protocol."
}
},
"required": [
"protocol",
"status",
"autoPairEnabled"
],
"unevaluatedProperties": false
}
}
},
"required": [
"deviceSerialNumber",
"customerType",
"deviceAccountRole",
"accountName",
"firstTimeRegistered",
"lastTimeRegistered",
"timeDeregistered",
"state",
"currentFirmwareVersion",
"deviceModel",
"localTimeOffset",
"ipAddress",
"customerLoginPool"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "1115FB4AD4D10805",
"customerType": "ADULT",
"deviceAccountRole": "PRIMARY",
"accountName": "Anna's Android device",
"firstTimeRegistered": "2025-08-21T07:03:23.310Z",
"lastTimeRegistered": "2025-08-21T07:03:23.310Z",
"timeDeregistered": "Not Available",
"state": "ACTIVE",
"currentFirmwareVersion": "2689890035",
"deviceModel": "MicrosoftMDG_RM-1085_12742_Windows_phone",
"localTimeOffset": "-8:00",
"ipAddress": "85.76.41.112",
"customerLoginPool": "Amazon",
"devicePairingDetails": {
"protocol": "Bluetooth",
"status": "INACTIVE",
"autoPairEnabled": false
}
}
]
Fire tablet screen sharing targets
This scope includes customer's screen sharing preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_screen_sharing_targets
- Amazon Data Portability
scopeId
:portability-fire-tablet-screen-sharing-targets
Fire tablet screen sharing targets
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The UTC timestamp when this record was created. | 1970-01-01T00:00:00Z |
deviceSerialNumber |
The Amazon serial number for the device. | G000RA0583640F99 |
softwareVersion |
The version of the Screen sharing app on the customer's device that registered. | 1.0 |
Sample schema:
{
"$schema": "http://json-schema.org/draft/2020-12/schema",
"title": "Mayday Screen Sharing - Device Registrations",
"description": "DeviceRegistration records are used to identify the customer device to which a screen sharing invitation will be sent.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"softwareVersion"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"default": "1970-01-01T00:00:00Z",
"description": "The UTC timestamp when this record was created."
},
"deviceSerialNumber": {
"type": "string",
"default": "DeviceSerialNumber",
"description": "The Amazon serial number for the device."
},
"softwareVersion": {
"type": "string",
"default": "1.0",
"description": "The version of the Screen sharing app on the customer's device that registered."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "1970-01-01T00:00:00Z",
"deviceSerialNumber": "G000RA0583640F99",
"softwareVersion": "1.0"
}
]
Fire tablet setup connections
This scope includes customer's device privacy preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_setup_connections
- Amazon Data Portability
scopeId
:portability-fire-tablet-setup-connections
Fire tablet input metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
provisionerDeviceType |
Provisioner device type id. | FIRE TABLETS |
provisionerDeviceModel |
Provisioner reported Model. | AFTEU011 |
provisionerFirmwareVersion |
Provisioner reported Firmware version. | 15.5 |
endTime |
Furthest events time stamp/Session End time. | 2017-05-06 22:06:04.0 |
provisioneeZigbeeMacAddress |
Provisionee Zigbee MAC Address. | 00:17:88:01:XX:XX:XX:XX |
provisioneeWifiMacAddress |
Provisionee Wi-Fi MAC Address. | null |
eventDate |
Earliest events time stamp/Session start time. | 2017-05-06 22:06:04.0 |
chosenSsidCredentialsChanged |
Indicates if the customer modified the credentials of pre-populated network credentials. | Yes |
provisioneeDeviceName |
Provisionee reported device name. | Echo Dot-W0J |
provisioneeDeviceModel |
Provisionee reported model. | A3VRME03NAXFUB |
deviceSerialNumber |
Provisionee provided Device Serial Number. | xxxxLF1071771JPX |
provisioneeHardwareVersion |
Provisionee reported hardware version. | P092R50324251B94 |
provisioneeFriendlyName |
Device friendly name. | null |
provisioneeFirmwareVersion |
Provisionee reported firmware version. | 7.1.2 |
provisioneeBLEMacAddress |
Provisionee BLE MAC address. | C3:A4:D2:D8:DD:DA |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Setup Connections",
"description": "Schema for devices Frustration free set up session details.",
"type": "array",
"items": {
"type": "object",
"required": [
"provisionerDeviceType",
"endTime",
"eventDate",
"deviceSerialNumber"
],
"unevaluatedProperties": false,
"properties": {
"provisionerDeviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Provisioner device type id."
},
"provisionerDeviceModel": {
"type": "string",
"description": "Provisioner reported Model."
},
"provisionerFirmwareVersion": {
"type": "string",
"description": "Provisioner reported Firmware version."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Furthest events time stamp/Session End time."
},
"provisioneeZigbeeMacAddress": {
"type": "string",
"description": "Provisionee Zigbee MAC Address."
},
"provisioneeWifiMacAddress": {
"type": "string",
"description": "Provisionee Wi-Fi MAC Address."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Earliest events time stamp/Session start time"
},
"chosenSsidCredentialsChanged": {
"type": "string",
"enum": [
"Yes",
"No",
"Not Available"
],
"description": "Indicates if the customer modified the credentials of pre-populated network credentials."
},
"provisioneeDeviceName": {
"type": "string",
"description": "Provisionee reported device name."
},
"provisioneeDeviceModel": {
"type": "string",
"description": "Provisionee reported model."
},
"deviceSerialNumber": {
"type": "string",
"description": "Provisionee provided Device Serial Number."
},
"provisioneeHardwareVersion": {
"type": "string",
"description": "Provisionee reported hardware version."
},
"provisioneeFriendlyName": {
"type": "string",
"description": "Device friendly name."
},
"provisioneeFirmwareVersion": {
"type": "string",
"description": "Provisionee reported firmware version."
},
"provisioneeBLEMacAddress": {
"type": "string",
"description": "Provisionee BLE MAC address."
}
}
}
}
Sample data based on the sample schema:
[
{
"provisionerDeviceType": "FIRE TABLETS",
"provisionerDeviceModel": "AFTEU011",
"provisionerFirmwareVersion": "15.5",
"endTime": "2017-05-06 22:06:04.0",
"provisioneeZigbeeMacAddress": "00:17:88:01:XX:XX:XX:XX",
"provisioneeWifiMacAddress": null,
"eventDate": "2017-05-06 22:06:04.0",
"chosenSsidCredentialsChanged": "Yes",
"provisioneeDeviceName": "Echo Dot-W0J",
"provisioneeDeviceModel": "A3VRME03NAXFUB",
"deviceSerialNumber": "xxxLF1071771JPX",
"provisioneeHardwareVersion": "mt8169",
"provisioneeFriendlyName": null,
"provisioneeFirmwareVersion": "7.1.2",
"provisioneeBLEMacAddress": "C3:A4:D2:D8:DD:DA"
}
]
Fire tablet usage metrics
This scope includes customer's customized device settings.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tablet_usage_metrics
- Amazon Data Portability
scopeId
:portability-fire-tablet-usage-metrics
Fire tablet usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2025-04-22T21:04:52Z |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type determines the internal identifier for launched device. | FIRE TABLETS |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute Inherited from Clickstream. | appAction |
reasonCode |
Describes context of DEM Metric, what triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Usage 3P",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on a device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type determines the internal identifier for launched device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute Inherited from Clickstream."
},
"reasonCode": {
"type": "string",
"description": "Describes context of DEM Metric, what triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2025-04-22T21:04:52Z",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRE TABLETS",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Fire TV Device Usage and Settings
This bucket includes information about how you use your Fire TV and manage its features, such as:
Fire TV channel preferences
This scope includes customer's TV channel scanning preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_channel_preferences
- Amazon Data Portability
scopeId
:portability-fire-tv-channel-preferences
Schema properties:
Properties | Details | Example value |
---|---|---|
postalCode |
Customers device postal code. | 75126 |
deviceSerialNumber |
Device serial number. | G3J0TV0094610062 |
ipAddress |
Customers device Ip address. | 97.100.75.29 |
eventDate |
The date when the event was generated. | 2023-08-10T08:55:41.803Z |
countryOfResidence |
Country code. | US |
preferredLanguageAmazonLocale |
Amazon Locale. | en_US |
preferredLanguage |
User preferred language. | en-us |
profileId |
Profile Id. | amzn1.actor.person.oid.A1CO1GYET3MSYP |
tsid |
Publically broadcasted Transport stream Id; used to uniquely identify a particular broadcast. | 1234 |
virtualChannelMajor |
Publically broadcasted major channel number. | 5678 |
virtualChannelMinor |
Publically broadcasted minor channel number. | 1234 |
channelType |
Publically broadcasted channel type; indicates whether a channel is from cable, terrestrial, or satellite. | TYPE_DVB_C |
broadcastedName |
Publically broadcasted station name. | Duck TV SD |
originalNetworkId |
Publically broadcasted original network Id; used to uniquely identify a particular broadcast. | 4321 |
serviceId |
Publically broadcasted service Id; used to uniquely identify an antenna source. | 8765 |
channelServiceType |
Publically broadcasted channel service type; indicates whether a channel is just audio or has audio and video. | SERVICE_TYPE_AUDIO_VIDEO |
stationName |
Name of station from Amazon's catalog. | SR Fernsehen HD |
stationCallsign |
Station callsign from Amazon's catalog. | WDR4RAD |
stationAttributes |
Attributes of station from Amazon's catalog. | HD |
stationGenre |
Genre of station from Amazon's Catalog. | com.amazon.live.genre.sports |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "FireTv OtaStationMatching",
"description": "Customer data that is used by FireTv devices in order to correctly tune to the correct OTA (Over The Air) channel and retrieve associated metadata from FireTv's Catalog records.",
"type": "array",
"items": {
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"description": "Customers device postal code."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"ipAddress": {
"type": "string",
"description": "Customers device Ip address."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date when the event was generated."
},
"countryOfResidence": {
"type": "string",
"description": "Country code.",
"pattern": "(^[A-Z]{2}$)|(Not Available)"
},
"preferredLanguageAmazonLocale": {
"type": "string",
"description": "Amazon Locale.",
"pattern": "(^[a-z]{2}-[A-Z]{2}$)|(Not Available)"
},
"preferredLanguage": {
"type": "string",
"description": "User preferred language.",
"pattern": "(^[a-z]{2}-[A-Z]{2}$)|(Not Available)"
},
"profileId": {
"type": "string",
"description": "Profile Id."
},
"tsid": {
"type": "string",
"description": "Publically broadcasted Transport stream Id; used to uniquely identify a particular broadcast.",
"pattern": "(^[0-9]+$)|(Not Available)"
},
"virtualChannelMajor": {
"type": "string",
"description": "Publically broadcasted major channel number.",
"pattern": "(^[0-9]+$)|(Not Available)"
},
"virtualChannelMinor": {
"type": "string",
"description": "Publically broadcasted minor channel number.",
"pattern": "(^[0-9]+$)|(Not Available)"
},
"channelType": {
"type": "string",
"enum": [
"TYPE_ATSC_T",
"TYPE_ATSC3_T",
"TYPE_ATSC_C",
"DVB_C",
"DVB_S",
"DVB_T",
"TYPE_DVB_C",
"TYPE_DVB_C2",
"TYPE_DVB_S",
"TYPE_DVB_S2",
"TYPE_DVB_SH",
"TYPE_DVB_T",
"TYPE_DVB_T2",
"OTA",
"CABLE",
"SATELLITE",
"TERRESTRIAL",
"Not Available"
],
"description": "Publically broadcasted channel type; indicates whether a channel is from cable, terrestrial, or satellite."
},
"broadcastedName": {
"type": "string",
"description": "Publically broadcasted station name."
},
"originalNetworkId": {
"type": "string",
"description": "Publically broadcasted original network Id; used to uniquely identify a particular broadcast.",
"pattern": "(^[0-9]+$)|(Not Available)"
},
"serviceId": {
"type": "string",
"description": "Publically broadcasted service Id; used to uniquely identify an antenna source.",
"pattern": "(^[0-9]+$)|(Not Available)"
},
"channelServiceType": {
"type": "string",
"enum": [
"SERVICE_TYPE_AUDIO_VIDEO",
"SERVICE_TYPE_HBBTV_DATA",
"SERVICE_TYPE_AUDIO",
"SERVICE_TYPE_OTHER",
"SERVICE_TYPE_DATA",
"Not Available"
],
"description": "Publically broadcasted channel service type; indicates whether a channel is just audio or has audio and video."
},
"stationName": {
"type": "string",
"description": "Name of station from Amazon's catalog."
},
"stationCallsign": {
"type": "string",
"description": "Station callsign from Amazon's catalog."
},
"stationAttributes": {
"type": "string",
"description": "Attributes of station from Amazon's catalog."
},
"stationGenre": {
"type": "string",
"description": "Genre of station from Amazon's Catalog."
}
},
"required": [
"deviceSerialNumber",
"eventDate"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"postalCode": "75126",
"deviceSerialNumber": "G3J0TV0094610062",
"ipAddress": "97.100.75.29",
"eventDate": "2023-08-10T08:55:41.803Z",
"countryOfResidence": "US",
"preferredLanguageAmazonLocale": "en_US",
"preferredLanguage": "en-us",
"profileId": "amzn1.actor.person.oid.A1CO1GYET3MSYP",
"tsid": "1234",
"virtualChannelMajor": "5678",
"virtualChannelMinor": "1234",
"channelType": "TYPE_DVB_C",
"broadcastedName": "Duck TV SD",
"originalNetworkId": "4321",
"serviceId": "8765",
"channelServiceType": "SERVICE_TYPE_AUDIO_VIDEO",
"stationName": "SR Fernsehen HD",
"stationCallsign": "WDR4RAD",
"stationAttributes": "HD",
"stationGenre": "com.amazon.live.genre.sports"
}
]
Fire TV registrations
This scope includes device registration status.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_registrations
- Amazon Data Portability
scopeId
:portability-fire-tv-registrations
Fire TV registrations
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Unique serial number identifier for the FireTablet device. | 1115FB4AD4D10805 |
customerType |
Type of customer account - either adult or child account. | ADULT |
deviceAccountRole |
Role of the device in the account - primary or secondary device. | PRIMARY |
accountName |
Display name of the account associated with the device. | Anna's Android device |
firstTimeRegistered |
Timestamp when the device was first registered to an account. | 2025-08-21T07:03:23.310Z |
lastTimeRegistered |
Timestamp of the most recent registration event for the device. | 2025-08-21T07:03:23.310Z |
timeDeregistered |
Timestamp when the device was deregistered from the account, or 'Not Available' if still registered. | Not Available |
state |
Current operational state of the device registration. | ACTIVE |
currentFirmwareVersion |
Version number of the firmware currently installed on the device. | 2689890035 |
deviceModel |
Model identifier of the FireTablet device. | MicrosoftMDG_RM-1085_12742_Windows_phone |
localTimeOffset |
Time zone offset from UTC for the device's local time. | -8:00 |
ipAddress |
Last known IP address of the device. | 85.76.41.112 |
customerLoginPool |
Authentication pool used for customer login (e.g., Amazon, Enterprise). | Amazon |
devicePairingDetails |
List of device pairing configurations and their status.. | N/A |
devicePairingDetails.protocol |
Communication protocol used for device pairing. | Bluetooth |
devicePairingDetails.status |
Current status of the pairing connection. | INACTIVE |
devicePairingDetails.autoPairEnabled |
Whether automatic pairing is enabled for this protocol. | false |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Registration",
"description": "Device registration information of FireTV devices.",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"type": "string",
"description": "Unique serial number identifier for the FireTV device."
},
"customerType": {
"type": "string",
"enum": [
"ADULT",
"CHILD"
],
"description": "Type of customer account - either adult or child account."
},
"deviceAccountRole": {
"type": "string",
"enum": [
"PRIMARY",
"SECONDARY"
],
"description": "Role of the device in the account - primary or secondary device."
},
"accountName": {
"type": "string",
"description": "Display name of the account associated with the device."
},
"firstTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device was first registered to an account."
},
"lastTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the most recent registration event for the device."
},
"timeDeregistered": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Available"
}
],
"description": "Timestamp when the device was deregistered from the account, or 'Not Available' if still registered."
},
"state": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current operational state of the device registration."
},
"currentFirmwareVersion": {
"type": "string",
"description": "Version number of the firmware currently installed on the device."
},
"deviceModel": {
"type": "string",
"description": "Model identifier of the FireTV device."
},
"localTimeOffset": {
"type": "string",
"description": "Time zone offset from UTC for the device's local time."
},
"ipAddress": {
"type": "string",
"description": "Last known IP address of the device."
},
"customerLoginPool": {
"type": "string",
"description": "Authentication pool used for customer login (e.g., Amazon, Enterprise)."
},
"devicePairingDetails": {
"type": "array",
"description": "List of device pairing configurations and their status.",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"description": "Communication protocol used for device pairing."
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current status of the pairing connection."
},
"autoPairEnabled": {
"type": "boolean",
"description": "Whether automatic pairing is enabled for this protocol."
}
},
"required": [
"protocol",
"status",
"autoPairEnabled"
],
"unevaluatedProperties": false
}
}
},
"required": [
"deviceSerialNumber",
"customerType",
"deviceAccountRole",
"accountName",
"firstTimeRegistered",
"lastTimeRegistered",
"timeDeregistered",
"state",
"currentFirmwareVersion",
"deviceModel",
"localTimeOffset",
"ipAddress",
"customerLoginPool"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "1115FB4AD4D10805",
"customerType": "ADULT",
"deviceAccountRole": "PRIMARY",
"accountName": "Anna's Android device",
"firstTimeRegistered": "2025-08-21T07:03:23.310Z",
"lastTimeRegistered": "2025-08-21T07:03:23.310Z",
"timeDeregistered": "Not Available",
"state": "ACTIVE",
"currentFirmwareVersion": "2689890035",
"deviceModel": "MicrosoftMDG_RM-1085_12742_Windows_phone",
"localTimeOffset": "-8:00",
"ipAddress": "85.76.41.112",
"customerLoginPool": "Amazon",
"devicePairingDetails": {
"protocol": "Bluetooth",
"status": "INACTIVE",
"autoPairEnabled": false
}
}
]
Fire TV setup connections
This scope includes customer's device privacy preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_setup_connections
- Amazon Data Portability
scopeId
:portability-fire-tv-setup-connections
Fire TV setup connections
Schema properties:
Properties | Details | Example value |
---|---|---|
provisionerDeviceType |
Provisioner device type id. | FIRETV |
provisionerDeviceModel |
Provisioner reported Model. | AFTEU011 |
provisionerFirmwareVersion |
Provisioner reported Firmware version. | 15.5 |
endTime |
Furthest events time stamp/Session End time. | 2017-05-06 22:06:04.0 |
provisioneeZigbeeMacAddress |
Provisionee Zigbee MAC Address. | 00:17:88:01:XX:XX:XX:XX |
provisioneeWifiMacAddress |
Provisionee Wi-Fi MAC Address. | null |
eventDate |
Earliest events time stamp/Session start time. | 2017-05-06 22:06:04.0 |
chosenSsidCredentialsChanged |
Indicates if the customer modified the credentials of pre-populated network credentials. | Yes |
provisioneeDeviceName |
Provisionee reported device name. | Echo Dot-W0J |
provisioneeDeviceModel |
Provisionee reported model. | A3VRME03NAXFUB |
deviceSerialNumber |
Provisionee provided Device Serial Number. | xxxxLF1071771JPX |
provisioneeHardwareVersion |
Provisionee reported hardware version. | P092R50324251B94 |
provisioneeFriendlyName |
Device friendly name. | null |
provisioneeFirmwareVersion |
Provisionee reported firmware version. | 7.1.2 |
provisioneeBLEMacAddress |
Provisionee BLE MAC address. | C3:A4:D2:D8:DD:DA |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Setup Connections",
"description": "Schema for devices Frustration free set up session details.",
"type": "array",
"items": {
"type": "object",
"required": [
"provisionerDeviceType",
"endTime",
"eventDate",
"deviceSerialNumber"
],
"unevaluatedProperties": false,
"properties": {
"provisionerDeviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Provisioner device type id."
},
"provisionerDeviceModel": {
"type": "string",
"description": "Provisioner reported Model."
},
"provisionerFirmwareVersion": {
"type": "string",
"description": "Provisioner reported Firmware version."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Furthest events time stamp/Session End time."
},
"provisioneeZigbeeMacAddress": {
"type": "string",
"description": "Provisionee Zigbee MAC Address."
},
"provisioneeWifiMacAddress": {
"type": "string",
"description": "Provisionee Wi-Fi MAC Address."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Earliest events time stamp/Session start time"
},
"chosenSsidCredentialsChanged": {
"type": "string",
"enum": [
"Yes",
"No",
"Not Available"
],
"description": "Indicates if the customer modified the credentials of pre-populated network credentials."
},
"provisioneeDeviceName": {
"type": "string",
"description": "Provisionee reported device name."
},
"provisioneeDeviceModel": {
"type": "string",
"description": "Provisionee reported model."
},
"deviceSerialNumber": {
"type": "string",
"description": "Provisionee provided Device Serial Number."
},
"provisioneeHardwareVersion": {
"type": "string",
"description": "Provisionee reported hardware version."
},
"provisioneeFriendlyName": {
"type": "string",
"description": "Device friendly name."
},
"provisioneeFirmwareVersion": {
"type": "string",
"description": "Provisionee reported firmware version."
},
"provisioneeBLEMacAddress": {
"type": "string",
"description": "Provisionee BLE MAC address."
}
}
}
}
Sample data based on the sample schema:
[
{
"provisionerDeviceType": "FIRETV",
"provisionerDeviceModel": "AFTEU011",
"provisionerFirmwareVersion": "15.5",
"endTime": "2017-05-06 22:06:04.0",
"provisioneeZigbeeMacAddress": "00:17:88:01:XX:XX:XX:XX",
"provisioneeWifiMacAddress": null,
"eventDate": "2017-05-06 22:06:04.0",
"chosenSsidCredentialsChanged": "Yes",
"provisioneeDeviceName": "Echo Dot-W0J",
"provisioneeDeviceModel": "A3VRME03NAXFUB",
"deviceSerialNumber": "xxxLF1071771JPX",
"provisioneeHardwareVersion": "mt8169",
"provisioneeFriendlyName": null,
"provisioneeFirmwareVersion": "7.1.2",
"provisioneeBLEMacAddress": "C3:A4:D2:D8:DD:DA"
}
]
Fire TV system settings
This scope includes customer's system settings configuration.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_system_settings
- Amazon Data Portability
scopeId
:portability-fire-tv-system-settings
Fire TV system settings
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Device Serial Number. | G4N0VM0490121LAT |
settingLevelType |
Defines whether the settings are saved on a user level (PROFILE )or device level (Device). | Device |
settingLevelKey |
Provides the user if the setting level is saved under PROFILE, or Default if the settings is under Device level. | Default |
settingName |
Setting Name - Represent the setting name. | Device Usage Data |
settingValue |
Provides the setting change defined under the Setting Name field. | On |
deviceUpdateTime |
It indicates when the device got synced with cloud. | 2022-11-04T06:16:12Z |
Sample schema:
{
"$schema": "http://json-schema.org/draft/2020-12/schema",
"title": "FireTvSysapps",
"description": "FireTV settings synced data across devices owned by the customer",
"type": "array",
"items": {
"type": "object",
"required": [
"deviceSerialNumber",
"settingLevelType",
"settingLevelKey",
"settingName",
"settingValue",
"deviceUpdateTime"
],
"unevaluatedProperties": false,
"properties": {
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number",
"default": "DeviceSerialNumber"
},
"settingLevelType": {
"type": "string",
"description": "Defines whether the settings are saved on a user level (PROFILE )or device level (Device)",
"default": "Device"
},
"settingLevelKey": {
"type": "string",
"description": "Provides the user if the setting level is saved under PROFILE, or Default if the settings is under Device level.",
"default": "Default"
},
"settingName": {
"type": "string",
"description": "Setting Name - Represent the setting name",
"default": "Setting Name"
},
"settingValue": {
"type": "string",
"description": "Provides the setting change defined under the Setting Name field.",
"default": "On"
},
"deviceUpdateTime": {
"type": "string",
"format": "date-time",
"description": "It indicates when the device got synced with cloud.",
"default": "1970-01-01T00:00:00Z"
}
}
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "G4N0VM0490121LAT",
"settingLevelType": "Device",
"settingLevelKey": "Default",
"settingName": "Device Usage Data",
"settingValue": "On",
"deviceUpdateTime": "2022-11-04T06:16:12Z"
}
]
Fire TV usage metrics
This scope includes customer's customized device settings.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_usage_metrics
- Amazon Data Portability
scopeId
:portability-fire-tv-usage-metrics
Fire TV usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2025-04-22T21:04:52Z |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type determines the internal identifier for launched device. | FIRETV |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute Inherited from Clickstream. | appAction |
reasonCode |
Describes context of DEM Metric, what triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Usage 3P",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on a device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type determines the internal identifier for launched device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute Inherited from Clickstream."
},
"reasonCode": {
"type": "string",
"description": "Describes context of DEM Metric, what triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2025-04-22T21:04:52Z",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRETV",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Fire TV engagement metrics
This scope includes customer's device activity and setup information.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_engagement_metrics
- Amazon Data Portability
scopeId
:portability-fire-tv-engagement-metrics
Device Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type. | FIRETV |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute representing the type of metric being measured. | appAction |
reasonCode |
What triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement",
"description": "Device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on a device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device"
},
"softwareVersion": {
"type": "string",
"description": "Device software version"
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "What triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRETV",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Application Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
appPackageName |
Package name of application for which metric is associated. | com.amazon.avod |
appVersionName |
Version of the application for which the metric is associated. | 5.7.3-17 |
appVersionCode |
Numeric value of the application version. | 573001710 |
deviceType |
Device type. | FIRETV |
deviceProfileType |
Profile Type. | Adult |
appProfileType |
Type of App profile. | Adult |
launchCount |
Number of times app has been launched. | 7 |
durationMilliseconds |
Duration of app in use for the metric session in milliseconds. | 901141 |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
metricLevel |
Attribute Inherited from Clickstream representing the type of metric being measured. | appAction |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
reasonCode |
Describes context of metric. | VOICE_OFF |
metricSource |
Device source of metric. | APP |
startTime |
Timestamp when the app launched. | 2017-05-06 22:06:04.0 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "App Engagement",
"description": "Application usage data including device information and app metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"appPackageName": {
"type": "string",
"description": "Package name of application for which metric is associated."
},
"appVersionName": {
"type": "string",
"description": "Version of the application for which the metric is associated."
},
"appVersionCode": {
"type": "string",
"description": "Numeric value of the application version."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device Type"
},
"deviceProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Profile Type."
},
"appProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Type of App profile."
},
"launchCount": {
"type": "string",
"description": "Number of times app has been launched."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of app in use for the metric session in milliseconds."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
},
"metricSource": {
"type": "string",
"description": "Device source of metric."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the app launched."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"appPackageName": "com.amazon.avod",
"appVersionName": "5.7.3-17",
"appVersionCode": "573001710",
"deviceType": "FIRETV",
"deviceProfileType": "Adult",
"appProfileType": "Adult",
"launchCount": "7",
"durationMilliseconds": "901141",
"softwareVersion": "36.5.7.3_user_573210520",
"metricLevel": "appAction",
"productMode": "SHOW_MODE",
"reasonCode": "VOICE_OFF",
"metricSource": "APP",
"startTime": "2017-05-06 22:06:04.0"
}
]
Third-party device usage data including device information and software details
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type. | FIRETV |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | DEFAULT |
metricLevel |
Attribute representing the type of metric being measured. | deviceAction |
reasonCode |
Describes context of metric. | VOICE_ON |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement 3p ACK",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRETV",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_ON"
}
]
Out Of Box Experience (OOBE) staging data including device and navigation details
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Device UTC timestamp at the time of recording the event. | 2021-01-08 04:25:53.0 |
deviceSerialNumber |
Device Serial Number. | G001DE4567890D6C |
deviceType |
Describes major device category. | FIRETV |
osVersion |
Device Software Version. | 36.5.7.3_user_573210520 |
deviceSessionId |
Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS). | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSessionId |
App-level session ID, a unique "session" within the app itself. | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSequenceId |
App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1). | 1 |
appPackageName |
The app package name that corresponds to the OOBE step. | com.amazon.oobe |
appVersion |
App version or application used for Out Of Box Experience. | 1.0.207001.0_13065210 |
appProfileType |
Type of App profile. | Adult |
deviceProfile |
Device profile identifier. | Device profile identifier. |
deviceProfileType |
Profile Type. | Adult |
fromPage |
The previous page_id. | OOBE |
toPage |
The next page_id after the current step . | Registration |
currentPage |
Page Name/ID to identify the page. | LanguagePicker |
metricName |
The metric event. | LanguagePickerModule_END |
sequenceId |
High level incrementing sequence id for out of box experience process. | 2 |
eventDurationMilliseconds |
The duration of the event. | 901141 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement Metrics",
"description": "Out Of Box Experience (OOBE) staging data including device and navigation details",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"metricName",
"currentPage",
"sequenceId",
"osVersion",
"appSessionId"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Device UTC timestamp at the time of recording the event."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Describes major device category."
},
"osVersion": {
"type": "string",
"description": "Device Software Version."
},
"deviceSessionId": {
"type": "string",
"description": "Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS)."
},
"appSessionId": {
"type": "string",
"description": "App-level session ID, a unique 'session' within the app itself."
},
"appSequenceId": {
"type": "string",
"description": "App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1)."
},
"appPackageName": {
"type": "string",
"description": "The app package name that corresponds to the OOBE step."
},
"appVersion": {
"type": "string",
"description": "App version or application used for Out Of Box Experience."
},
"appProfileType": {
"type": "string",
"description": "Type of App profile."
},
"deviceProfile": {
"type": "string",
"description": "Device profile identifier."
},
"deviceProfileType": {
"type": "string",
"description": "Profile Type."
},
"fromPage": {
"type": "string",
"description": "The previous page_id."
},
"toPage": {
"type": "string",
"description": "The next page_id after the current step."
},
"currentPage": {
"type": "string",
"description": "Page Name/ID to identify the page."
},
"metricName": {
"type": "string",
"description": "The metric event."
},
"sequenceId": {
"type": "string",
"description": "High level incrementing sequence id for out of box experience process."
},
"eventDurationMilliseconds": {
"type": "string",
"description": "The duration of the event."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2021-01-08 04:25:53.0",
"deviceSerialNumber": "G001DE4567890D6C",
"deviceType": "FIRETV",
"osVersion": "36.5.7.3_user_573210520",
"deviceSessionId": "b7c498dc-c394-4d93-81ed-bbd9d5d4511d",
"appSessionId": "db5801e6-20f1-42b4-ac51-e3b1c4597da3",
"appSequenceId": "0",
"appPackageName": "com.amazon.oobe",
"appVersion": "1.0.207001.0_13065210",
"appProfileType": "Adult",
"deviceProfile": "com.amazon.oid.AZADASASASAS",
"deviceProfileType": "Adult",
"fromPage": "OOBE",
"toPage": "WiFi",
"currentPage": "LanguagePicker",
"metricName": "LanguagePickerModule_END",
"sequenceId": "1",
"eventDurationMilliseconds": "90114"
}
]
Total usage data including device information and usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
startTime |
When the total usage event was started in timestamp format. | 2017-05-06 22:06:04.0 |
endTime |
When the total usage event was ended in timestamp format. | 2017-05-06 22:06:04.0 |
durationMilliseconds |
Duration of total_usage event in milliseconds. | 901141 |
metricName |
Device metric information. | TOTAL_USAGE |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
triggerType |
Describes context of total usage Metric, what triggered the metric. | SCREEN_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage",
"description": "Total usage data including device information and usage metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"durationMilliseconds",
"metricName",
"softwareVersion"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was started in timestamp format."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was ended in timestamp format."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of total_usage event in milliseconds."
},
"metricName": {
"type": "string",
"description": "Device metric information."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"triggerType": {
"type": "string",
"description": "Describes context of total usage Metric, what triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"startTime": "2017-05-06 22:06:04.0",
"endTime": "2017-05-06 22:06:04.0",
"durationMilliseconds": "901141",
"metricName": "TOTAL_USAGE",
"softwareVersion": "36.5.7.3_user_573210520",
"triggerType": "SCREEN_OFF"
}
]
Total usage data for each user, device, and day
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The date that has been aggregated to for this set of metrics. | 2025-08-10T00:00:00Z |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Product category. | FIRETV |
asin |
ASIN of the product. | B00KQO3EVM |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
durationMilliseconds |
Total amount of time for a specific metric on the day for the specific device serial number. | 901141 |
powerLossCount |
The number of times a customer powered off the device for the day. | 1 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage Per Day",
"description": "This table stores total usage rolled up to a per-user/per-device, per-day level.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"softwareVersion",
"durationMilliseconds"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date that has been aggregated to for this set of metrics."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Product category."
},
"asin": {
"type": "string",
"description": "ASIN of the product."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"durationMilliseconds": {
"type": "string",
"description": "Total amount of time for a specific metric on the day for the specific device serial number."
},
"powerLossCount": {
"type": "string",
"description": "The number of times a customer powered off the device for the day."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2025-08-10T00:00:00Z",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "FIRETV",
"asin": "B00KQO3EVM",
"softwareVersion": "36.5.7.3_user_573210520",
"durationMilliseconds": "901141",
"powerLossCount": "1"
}
]
Fire TV events
This scope includes customer's screen sharing preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_events
- Amazon Data Portability
scopeId
:portability-fire-tv-events
Fire TV events
Schema properties:
Properties | Details | Example value |
---|---|---|
customerCountryCode |
The customer's country of residence. | US |
customerInterestBasedAdsSetting |
The customer's interest based ads setting. | ON |
customerSubscriptionsAndEntitlements |
The customer's list of subscriptions and entitlements to third party services. | Hulu, Netflix |
deviceFireOsVersion |
The device's FireOS version. | 5.2.7.4 |
deviceManufacturer |
The device's manufacturer. | Amazon |
deviceModelName |
The device's model. | Fire TV - 1st Gen (2014) |
deviceSerialNumber |
The device's device serial number. | 01234—789ABC--- |
eventDate |
The event's date (UTC). | 2020-01-01T00:00:00.000+0000 |
eventName |
The action being taken on the UI element. | Click |
alexaEventContextLastMediaPlaybackState |
The state of media playback on the device at the time of the Alexa voice request. | Playing |
alexaEventContextLocale |
The locale associated with the Alexa event. | en-US |
alexaEventDate |
The date associated with the Alexa event (UTC). | 2020-01-01T00:00:00.000+0000 |
alexaEventName |
The name associated with the Alexa event. | AlexaShortcutPanelEvent |
inAmbientMode |
If the device is in ambient mode. | true |
alexaShortcutPanelExperience |
The type of the Alexa shortcut panel experience. | Personalized |
eventMetadata |
The various metadata associated with the Alexa event. | N/A |
eventMetadata.customMetadata |
The custom metadata associated with the Alexa event. | Try \"Alexa, what should I watch?\" |
eventMetadata.domainName |
The domain name associated with the Alexa event. | Smart Home |
eventMetadata.interactionMode |
The interaction mode that triggered the Alexa event. | Voice |
eventType |
The event triggered by the Alexa shortcuts panel experience. | Action |
tileUxType |
The type of the tile UX. | Static |
alexaDeviceInitiator |
How the customer initiated the voice request on the device. | Press And Hold |
alexaResponseChannel |
How the customer will experience the response Alexa sends to the device. | Audio |
domainHintShown |
The domain name of the Alexa shortcuts panel experience. | Smart Home |
mediaCommand |
The command executed to change the playback state of the current media. | Play |
name |
This field is used to differentiate between the different types of event emitted. | SettingScreen |
flowResult |
The result of the device onboarding flow for the customer. | Success |
detectedDevices |
List of detected devices. | TV, Set Top Box, Audio Video Receiver |
notSupportedDevices |
List of not supported devices. | TV, Set Top Box, Audio Video Receiver |
onboardedDevices |
List of onboarded devices. | TV, Set Top Box, Audio Video Receiver |
skippedDevices |
List of skipped devices. | TV, Set Top Box, Audio Video Receiver |
screenName |
The name of the screen displayed in the UI. | FTVAmbient |
rowName |
The name of the row within the screen displayed in the UI. | ContextMenu |
itemName |
The name of the item within the row displayed in the UI. | ContextMenu:RemoveWidget |
backgroundIsPersonalPhoto |
If the background is from Amazon Photos or from stock content collections. | true |
backgroundRotationSpeedInMinutes |
The rotation speed of the ambient background image in minutes. | 1 |
backgroundShuffle |
If the images in selected collections are being shuffled. | true |
navigationMethod |
The egress type for the event. | Voice |
referralMechanism |
The ingress type for the event. | Voice |
screenId |
The name of the screen associated with the event. | AcrPromptScreen |
optionName |
The name of the settings option. | AcrPromptAction |
userInteraction |
The value of the settings option that the customer selects. | Enable |
currentSettingValue |
The value of the setting before the customer selects the option. | On |
newSettingValue |
The value of the setting after the customer selects the option. | On |
appVersion |
The version of the application. | 1 |
promptCount |
The number of times the prompt has appeared before. | 1 |
setTopBoxAvailable |
If a set-top box is available. | true |
alexaResponseNamespace |
The namespace of the received Alexa response. | ChannelController |
alexaResponseName |
The name of the received Alexa response. | ChangeChannel |
alexaResponseActionableValue |
The actionable value supplied through the received Alexa response. | UP |
alexaResponseOrigin |
The origin of the received Alexa response (far field control, near field control, or other control). | Far Field Control |
alexaResponseResult |
The result of the Alexa response execution. | Success |
dualModeState |
The state of dual mode when the Alexa response was received. | ECHO |
isConsumerElectronicsControlSupported |
If the target device supports consumer electronics control. | true |
isInfraredControlSupported |
If the target device supports infrared control. | true |
isDiscoveredViaHdmiCec |
Is the target device generated by automatically scanning the HDMI-CEC bus. | true |
remoteKeyName |
The name of the remote key supplied by FireOS. | KEYCODE_VOLUME_UP |
remoteKeyPressDurationInMilliseconds |
How long the remote key was held down in milliseconds. | 1 |
targetDeviceType |
The type of the target device. | TV |
deviceSetupSessionId |
The id used for a device setup session. | 4e2493cc-e857-4cce-b16f-bb25add8180c |
deviceSetupSessionType |
The type of the device setup flow the customer is currently in. | First Time Registration |
deviceSetupProperties |
The various properties associated with the device setup event. | N/A |
deviceSetupProperties.countryCodeBasedOnIp |
The country code based on the IP address. | US |
deviceSetupProperties.status |
The status of the step in the device setup flow the customer is currently in. | success |
deviceSetupProperties.wifiScanDurationsInMillis |
Duration of the WiFi scan in milliseconds. | 1 |
deviceSetupProperties.networkConnected |
Network connected. | TRUE |
deviceSetupProperties.typeOfNetworkConnected |
Type of network connected. | WiFi |
deviceSetupProperties.signalStrengthOfConnectedWifiNetwork |
WiFi Signal strength. | Good |
deviceSetupProperties.securityOfConnectedWifiNetwork |
WiFi Security type. | WPA2 |
performanceUseCaseName |
The use case name of the performance event. | App Launch Time to First Frame |
packageBeingUsedBeforeAction |
The application package name associated with the performance use case before the time of the action. | com.example.myapplication |
packageBeingUsedAfterAction |
The application package name associated with the performance use case after the time of the action. | com.example.myapplication |
packageBeingUsedDuringAction |
The application package name associated with the performance use case at the time of the action. | com.example.myapplication |
performanceStartDate |
The start date of the use case of the performance event (UTC). | 2020-01-01T00:00:00.000+0000 |
performanceEndDate |
The end date of the use case of the performance event (UTC). | 2020-01-01T00:00:00.000+0000 |
performanceOverallTimeInSeconds |
The total time it took to perform the use case of the performance event in seconds. | 1 |
appStatus |
The launch status of when the customer tries to open the application associated with the performance event. | First time app launch |
triggerAction |
The action the customer took to trigger the performance event. | KEYCODE_0 |
remoteBatteryLevel |
The battery level of the remote when it is being paired. | 100 |
remoteFirmwareVersion |
The remote firmware version. | 1 |
remotePairingContext |
The application that the customer uses to pair the remote. | com.example.myapplication |
remoteProductId |
The remote product id. | 1 |
remoteType |
The type of remote that is paired. | BLE |
remoteVendorId |
The remote vendor id. | 1 |
freeSpaceInMegabytes |
The amount of free space available on the device in megabytes. | 1000 |
action |
The action performed by the UI element. | ShortcutAdded |
itemPosition |
The relative position of the item within the row displayed in the UI. | 1 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Fire TV Events",
"description": "Includes data about how Amazon customers interact with their Fire TV device(s).",
"type": "array",
"items": {
"type": "object",
"properties": {
"customerCountryCode": {
"description": "The customer's country of residence.",
"type": "string"
},
"customerInterestBasedAdsSetting": {
"description": "The customer's interest based ads setting.",
"type": "string"
},
"customerSubscriptionsAndEntitlements": {
"description": "The customer's list of subscriptions and entitlements to third party services.",
"type": "array",
"items": {
"type": "string"
}
},
"deviceFireOsVersion": {
"description": "The device's FireOS version.",
"type": "string"
},
"deviceManufacturer": {
"description": "The device's manufacturer.",
"type": "string"
},
"deviceModelName": {
"description": "The device's model.",
"type": "string"
},
"deviceSerialNumber": {
"description": "The device's device serial number.",
"type": "string"
},
"eventDate": {
"description": "The event's date (UTC).",
"type": "string",
"format": "date-time"
},
"eventName": {
"description": "The action being taken on the UI element.",
"type": "string"
},
"alexaEventContextLastMediaPlaybackState": {
"description": "The state of media playback on the device at the time of the Alexa voice request.",
"type": "string"
},
"alexaEventContextLocale": {
"description": "The locale associated with the Alexa event.",
"type": "string"
},
"alexaEventDate": {
"description": "The date associated with the Alexa event (UTC).",
"type": "string",
"format": "date-time"
},
"alexaEventName": {
"description": "The name associated with the Alexa event.",
"type": "string"
},
"inAmbientMode": {
"description": "If the device is in ambient mode.",
"type": "boolean"
},
"alexaShortcutPanelExperience": {
"description": "The type of the Alexa shortcut panel experience.",
"type": "string"
},
"eventMetadata": {
"description": "The various metadata associated with the Alexa event.",
"type": "object",
"properties": {
"customMetadata": {
"description": "The custom metadata associated with the Alexa event.",
"type": "string"
},
"domainName": {
"description": "The domain name associated with the Alexa event.",
"type": "string"
},
"interactionMode": {
"description": "The interaction mode that triggered the Alexa event.",
"type": "string"
}
}
},
"eventType": {
"description": "The event triggered by the Alexa shortcuts panel experience.",
"type": "string"
},
"tileUxType": {
"description": "The type of the tile UX.",
"type": "string"
},
"alexaDeviceInitiator": {
"description": "How the customer initiated the voice request on the device.",
"type": "string"
},
"alexaResponseChannel": {
"description": "How the customer will experience the response Alexa sends to the device.",
"type": "string"
},
"domainHintShown": {
"description": "The domain name of the Alexa shortcuts panel experience.",
"type": "string"
},
"mediaCommand": {
"description": "The command executed to change the playback state of the current media.",
"type": "string"
},
"name": {
"description": "This field is used to differentiate between the different types of event emitted.",
"type": "string"
},
"flowResult": {
"description": "The result of the device onboarding flow for the customer.",
"type": "string"
},
"detectedDevices": {
"description": "List of detected devices.",
"type": "array",
"items": {
"type": "string"
}
},
"notSupportedDevices": {
"description": "List of not supported devices.",
"type": "array",
"items": {
"type": "string"
}
},
"onboardedDevices": {
"description": "List of onboarded devices.",
"type": "array",
"items": {
"type": "string"
}
},
"skippedDevices": {
"description": "List of skipped devices.",
"type": "array",
"items": {
"type": "string"
}
},
"screenName": {
"description": "The name of the screen displayed in the UI.",
"type": "string"
},
"rowName": {
"description": "The name of the row within the screen displayed in the UI.",
"type": "string"
},
"itemName": {
"description": "The name of the item within the row displayed in the UI.",
"type": "string"
},
"backgroundIsPersonalPhoto": {
"description": "If the background is from Amazon Photos or from stock content collections.",
"type": "boolean"
},
"backgroundRotationSpeedInMinutes": {
"description": "The rotation speed of the ambient background image in minutes.",
"type": "number"
},
"backgroundShuffle": {
"description": "If the images in selected collections are being shuffled.",
"type": "boolean"
},
"navigationMethod": {
"description": "The egress type for the event.",
"type": "string"
},
"referralMechanism": {
"description": "The ingress type for the event.",
"type": "string"
},
"screenId": {
"description": "The name of the screen associated with the event.",
"type": "string"
},
"optionName": {
"description": "The name of the settings option.",
"type": "string"
},
"userInteraction": {
"description": "The value of the settings option that the customer selects.",
"type": "string"
},
"currentSettingValue": {
"description": "The value of the setting before the customer selects the option.",
"type": "string"
},
"newSettingValue": {
"description": "The value of the setting after the customer selects the option.",
"type": "string"
},
"appVersion": {
"description": "The version of the application.",
"type": "string"
},
"promptCount": {
"description": "The number of times the prompt has appeared before.",
"type": "number"
},
"setTopBoxAvailable": {
"description": "If a set-top box is available.",
"type": "boolean"
},
"alexaResponseNamespace": {
"description": "The namespace of the received Alexa response.",
"type": "string"
},
"alexaResponseName": {
"description": "The name of the received Alexa response.",
"type": "string"
},
"alexaResponseActionableValue": {
"description": "The actionable value supplied through the received Alexa response.",
"type": "string"
},
"alexaResponseOrigin": {
"description": "The origin of the received Alexa response (far field control, near field control, or other control).",
"type": "string"
},
"alexaResponseResult": {
"description": "The result of the Alexa response execution.",
"type": "string"
},
"dualModeState": {
"description": "The state of dual mode when the Alexa response was received.",
"type": "string"
},
"isConsumerElectronicsControlSupported": {
"description": "If the target device supports consumer electronics control.",
"type": "boolean"
},
"isInfraredControlSupported": {
"description": "If the target device supports infrared control.",
"type": "boolean"
},
"isDiscoveredViaHdmiCec": {
"description": "Is the target device generated by automatically scanning the HDMI-CEC bus.",
"type": "boolean"
},
"remoteKeyName": {
"description": "The name of the remote key supplied by FireOS.",
"type": "string"
},
"remoteKeyPressDurationInMilliseconds": {
"description": "How long the remote key was held down in milliseconds.",
"type": "number"
},
"targetDeviceType": {
"description": "The type of the target device.",
"type": "string"
},
"deviceSetupSessionId": {
"description": "The id used for a device setup session.",
"type": "string"
},
"deviceSetupSessionType": {
"description": "The type of the device setup flow the customer is currently in.",
"type": "string"
},
"deviceSetupProperties": {
"description": "The various properties associated with the device setup event.",
"type": "object",
"properties": {
"countryCodeBasedOnIp": {
"description": "The country code based on the IP address.",
"type": "string"
},
"status": {
"description": "The status of the step in the device setup flow the customer is currently in.",
"type": "string"
},
"WifiScanDurationsInMillis": {
"description": "Duration of the WiFi scan in milliseconds.",
"type": "string"
},
"networkConnected": {
"description": "Network connected.",
"type": "string"
},
"typeOfNetworkConnected": {
"description": "Type of network connected.",
"type": "string"
},
"signalStrengthOfConnectedWifiNetwork": {
"description": "WiFi Signal strength.",
"type": "string"
},
"securityOfConnectedWifiNetwork": {
"description": "WiFi Security type.",
"type": "string"
}
}
},
"performanceUseCaseName": {
"description": "The use case name of the performance event.",
"type": "string"
},
"packageBeingUsedBeforeAction": {
"description": "The application package name associated with the performance use case before the time of the action.",
"type": "string"
},
"packageBeingUsedAfterAction": {
"description": "The application package name associated with the performance use case after the time of the action.",
"type": "string"
},
"packageBeingUsedDuringAction": {
"description": "The application package name associated with the performance use case at the time of the action.",
"type": "string"
},
"performanceStartDate": {
"description": "The start date of the use case of the performance event (UTC).",
"type": "string",
"format": "date-time"
},
"performanceEndDate": {
"description": "The end date of the use case of the performance event (UTC).",
"type": "string",
"format": "date-time"
},
"performanceOverallTimeInSeconds": {
"description": "The total time it took to perform the use case of the performance event in seconds.",
"type": "number"
},
"appStatus": {
"description": "The launch status of when the customer tries to open the application associated with the performance event.",
"type": "string"
},
"triggerAction": {
"description": "The action the customer took to trigger the performance event.",
"type": "string"
},
"remoteBatteryLevel": {
"description": "The battery level of the remote when it is being paired.",
"type": "number"
},
"remoteFirmwareVersion": {
"description": "The remote firmware version.",
"type": "string"
},
"remotePairingContext": {
"description": "The application that the customer uses to pair the remote.",
"type": "string"
},
"remoteProductId": {
"description": "The remote product id.",
"type": "number"
},
"remoteType": {
"description": "The type of remote that is paired.",
"type": "string"
},
"remoteVendorId": {
"description": "The remote vendor id.",
"type": "number"
},
"freeSpaceInMegabytes": {
"description": "The amount of free space available on the device in megabytes",
"type": "number"
},
"action": {
"description": "The action performed by the UI element.",
"type": "string"
},
"itemPosition": {
"description": "The relative position of the item within the row displayed in the UI.",
"type": "number"
}
},
"required": [
"eventDate",
"eventName"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"customerCountryCode": "US",
"customerInterestBasedAdsSetting": "ON",
"customerSubscriptionsAndEntitlements": ["Hulu", "Netflix"],
"deviceFireOsVersion": "5.2.7.4",
"deviceManufacturer": "Amazon",
"deviceModelName": "Fire TV - 1st Gen (2014)",
"deviceSerialNumber": "01234—789ABC---",
"eventDate": "2020-01-01T00:00:00.000+0000",
"eventName": "Click",
"alexaEventContextLastMediaPlaybackState": "Playing",
"alexaEventContextLocale": "en-US",
"alexaEventDate": "2020-01-01T00:00:00.000+0000",
"alexaEventName": "AlexaShortcutPanelEvent",
"inAmbientMode": true,
"alexaShortcutPanelExperience": "Personalized",
"eventMetadata": {
"customMetadata": "Try \"Alexa, what should I watch?\"",
"domainName": "Smart Home",
"interactionMode": "Voice"
},
"eventType": "Action",
"tileUxType": "Static",
"alexaDeviceInitiator": "Press And Hold",
"alexaResponseChannel": "Audio",
"domainHintShown": "Smart Home",
"mediaCommand": "Play",
"name": "SettingScreen",
"flowResult": "Success",
"detectedDevices": ["TV", "Set Top Box", "Audio Video Receiver"],
"notSupportedDevices": ["TV", "Set Top Box", "Audio Video Receiver"],
"onboardedDevices": ["TV", "Set Top Box", "Audio Video Receiver"],
"skippedDevices": ["TV", "Set Top Box", "Audio Video Receiver"],
"screenName": "FTVAmbient",
"rowName": "ContextMenu",
"itemName": "ContextMenu:RemoveWidget",
"backgroundIsPersonalPhoto": true,
"backgroundRotationSpeedInMinutes": 1,
"backgroundShuffle": true,
"navigationMethod": "Voice",
"referralMechanism": "Voice",
"screenId": "AcrPromptScreen",
"optionName": "AcrPromptAction",
"userInteraction": "Enable",
"currentSettingValue": "On",
"newSettingValue": "On",
"appVersion": "1",
"promptCount": 1,
"setTopBoxAvailable": true,
"alexaResponseNamespace": "ChannelController",
"alexaResponseName": "ChangeChannel",
"alexaResponseActionableValue": "UP",
"alexaResponseOrigin": "Far Field Control",
"alexaResponseResult": "Success",
"dualModeState": "ECHO",
"isConsumerElectronicsControlSupported": true,
"isInfraredControlSupported": true,
"isDiscoveredViaHdmiCec": true,
"remoteKeyName": "KEYCODE_VOLUME_UP",
"remoteKeyPressDurationInMilliseconds": 1,
"targetDeviceType": "TV",
"deviceSetupSessionId": "4e2493cc-e857-4cce-b16f-bb25add8180c",
"deviceSetupSessionType": "First Time Registration",
"deviceSetupProperties": {
"countryCodeBasedOnIp": "US",
"status": "success",
"wifiScanDurationsInMillis": "1",
"networkConnected": "TRUE",
"typeOfNetworkConnected": "WiFi",
"signalStrengthOfConnectedWifiNetwork": "Good",
"securityOfConnectedWifiNetwork": "WPA2"
},
"performanceUseCaseName": "App Launch Time to First Frame",
"packageBeingUsedBeforeAction": "com.example.myapplication",
"packageBeingUsedAfterAction": "com.example.myapplication",
"packageBeingUsedDuringAction": "com.example.myapplication",
"performanceStartDate": "2020-01-01T00:00:00.000+0000",
"performanceEndDate": "2020-01-01T00:00:00.000+0000",
"performanceOverallTimeInSeconds": 1,
"appStatus": "First time app launch",
"triggerAction": "KEYCODE_0",
"remoteBatteryLevel": 100,
"remoteFirmwareVersion": "1",
"remotePairingContext": "BLE",
"remoteProductId": 1,
"remoteType": "1000",
"remoteVendorId": "ShortcutAdded",
"freeSpaceInMegabytes": 1000,
"action": "ShortcutAdded",
"itemPosition": 1
}
]
Fire TV screen sharing targets
This scope includes customer's screen sharing preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::fire_tv_screen_sharing_targets
- Amazon Data Portability
scopeId
:portability-fire-tv-screen-sharing-targets
Fire TV screen sharing targets
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The UTC timestamp when this record was created. | 1970-01-01T00:00:00Z |
deviceSerialNumber |
The Amazon serial number for the device. | G000RA0583640F99 |
softwareVersion |
The version of the Screen sharing app on the customer's device that registered. | 1.0 |
Sample schema:
{
"$schema": "http://json-schema.org/draft/2020-12/schema",
"title": "Mayday Screen Sharing - Device Registrations",
"description": "DeviceRegistration records are used to identify the customer device to which a screen sharing invitation will be sent.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"softwareVersion"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"default": "1970-01-01T00:00:00Z",
"description": "The UTC timestamp when this record was created."
},
"deviceSerialNumber": {
"type": "string",
"default": "DeviceSerialNumber",
"description": "The Amazon serial number for the device."
},
"softwareVersion": {
"type": "string",
"default": "1.0",
"description": "The version of the Screen sharing app on the customer's device that registered."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "1970-01-01T00:00:00Z",
"deviceSerialNumber": "G000RA0583640F99",
"softwareVersion": "1.0"
}
]
Kindle Device Usage and Settings
This bucket includes metrics on customer engagement with Kindle and information about device settings such as:
Kindle activity
This scope includes the customer's Kindle interaction and usage patterns.
Identifiers:
- Login with Amazon Scope Name:
portability::kindle_activity
- Amazon Data Portability
scopeId
:portability-kindle-activity
Hibernate wakeup
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
wakeupReason |
The reason of wakeup of the device from hibernate state. | Power button pressed |
timeInHibernation |
Time the device was in Hibernate state. | 1616767 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "Hibernate Wakeup",
"description": "This schema records the reason of wake up from hibernate state and also it records the time spent in hibernate state.",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"wakeupReason": {
"type": "string",
"description": "The reason of wakeup of the device from hibernate state"
},
"timeInHibernationInMs": {
"type": "number",
"description": "Time the device was in Hibernate state"
}
},
"required": [
"eventDate",
"country",
"deviceFamily",
"wakeupReason",
"timeInHibernationInMs"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"wakeupReason": "Power button pressed",
"timeInHibernation": 1616767
}
]
Framework connectivity
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
isChanged |
Whether the value was updated by the system or the user. | by user |
connectionState |
This field captures the connection state. | connected |
connectionName |
This field indicates the name/type of connection. | bluetooth |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "Framework Connectivity",
"description": "This schema captures the connectivity states in E-readers. Connectivity includes Bluetooth, Wireless etc.",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"isChanged": {
"type": "string",
"description": "Whether the value was updated by the system or the user"
},
"connectionState": {
"type": "string",
"description": "This field captures the connection state"
},
"connectionName": {
"type": "string",
"description": "This field indicates the name/type of connection"
}
},
"required": [
"eventDate",
"country",
"asin",
"deviceFamily",
"isChanged",
"connectionState",
"connectionName"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"isChanged": "by user",
"connectionState": "connected",
"connectionName": "bluetooth"
}
]
Power management state change
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
previousState |
Previous state name, when there was a state change. | ACTIVE |
currentState |
Current state name, when there is a state change. | NOT ACTIVE |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "POWERD State Change",
"description": "This schema records the powerd states when there is state change",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"previousState": {
"type": "string",
"description": "Previous state name, when there was a state change"
},
"currentState": {
"type": "string",
"description": "Current state name, when there is a state change"
}
},
"required": [
"eventDate",
"country",
"deviceFamily",
"asin",
"previousState",
"currentState"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"previousState": "ACTIVE",
"currentState": "NOT ACTIVE"
}
]
Wifi error dialogs instances
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
errorReason |
The error reason which caused the error dialog. | Internal Error |
selectedOption |
The option selected in the error dialog. | Try Again Selected |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "WIFI Error Dialogs",
"description": "This schema captures the wifi error dialogs instances with the error reason",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"errorReason": {
"type": "string",
"description": "The error reason which caused the error dialog"
},
"selectedOption": {
"type": "string",
"description": "The option selected in the error dialog"
}
},
"required": [
"eventDate",
"country",
"asin",
"deviceFamily",
"errorReason",
"selectedOption"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"errorReason": "Internal Error",
"selectedOption": "Try Again Selected"
}
]
Wifi connection time taken
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
timeInMs |
Time taken to connect to a Wifi Connection in Milliseconds. | 5560 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "WIFI Connection Time Taken",
"description": "This schema captures the data for the time taken to connect to a WiFi connection",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"timeInMs": {
"type": "number",
"description": "Time taken to connect to a Wifi Connection in Milliseconds"
}
},
"required": [
"eventDate",
"country",
"asin",
"deviceFamily",
"timeInMs"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"timeInMs": 5560
}
]
Low battery alert
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
lowBatteryAlertReason |
The reason/name of the alert. | primaryBattPercentVeryLowAlert |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "Low Battery Alert",
"description": "This schema records the metrics whenever a low battery dialog is shown to the user",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"lowBatteryAlertReason": {
"type": "string",
"description": "The reason/name of the alert"
}
},
"required": [
"eventDate",
"country",
"asin",
"deviceFamily",
"lowBatteryAlertReason"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"lowBatteryAlertReason": "primaryBattPercentVeryLowAlert"
}
]
Battery Drain From 80 To 10
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
timeInDays |
Time taken in days to drain the battery from 80 to 10 percentage. | 3 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "Battery Drain From 80 To 10",
"description": "This schema records the battery drain time in days for reaching from 80 to 10 percent",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"timeInDays": {
"type": "number",
"description": "Time taken in days to drain the battery from 80 to 10 percentage"
}
},
"required": [
"eventDate",
"country",
"asin",
"deviceFamily",
"timeInDays"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"timeInDays": 3
}
]
Settings Metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
This is the timestamp for when the record was created on the device/app. | 2015-04-29T10:15:00.500 |
country |
The country of residence of the customer. | US |
deviceFamily |
Can be thought of as the software stack or product from which the data is being emitted. | e-ink |
asin |
The asin in which the action was performed(publicly available asin). | B0026OR2ZY |
metricName |
Indicates the metric name. | Opened Quick Actions |
selectedValue |
Indicates the metric value. | Tapped Quick Actions drop-down button |
activePageName |
Indicates the page_id the quickactions is opened. | Home |
voiceViewStatus |
Indicates if the operations are performed in asr mode. | VoiceView turned on |
toPageName |
Indicates to which page user is navigated to when interacted with any widgets in quickactions. | Settings |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"title": "Settings Metrics",
"description": "Emitted when user clicks the widgets in quicksettings or operations performed in all settings.",
"items": {
"type": "object",
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "This is the timestamp for when the record was created on the device/app"
},
"country": {
"type": "string",
"description": "The country of residence of the customer"
},
"deviceFamily": {
"type": "string",
"description": "Can be thought of as the software stack or product from which the data is being emitted"
},
"asin": {
"type": "string",
"description": "The asin in which the action was performed(publicly available asin)"
},
"metricName": {
"type": "string",
"description": "Indicates the metric name"
},
"selectedValue": {
"type": "string",
"description": "Indicates the metric value"
},
"activePageName": {
"type": "string",
"description": "Indicates the page_id the quickactions is opened"
},
"voiceViewStatus": {
"type": "string",
"description": "Indicates if the operations are performed in asr mode"
},
"toPageName": {
"type": "string",
"description": "Indicates to which page user is navigated to when interacted with any widgets in quickactions"
}
},
"required": [
"eventDate",
"country",
"asin",
"deviceFamily",
"metricName",
"selectedValue",
"activePageName",
"voiceViewStatus"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2015-04-29T10:15:00.500",
"country": "US",
"deviceFamily": "e-ink",
"asin": "B0026OR2ZY",
"metricName": "Opened Quick Actions",
"selectedValue": "Tapped Quick Actions drop-down button",
"activePageName": "Home",
"voiceViewStatus": "VoiceView turned on",
"toPageName": "Settings"
}
]
Kindle registrations
This scope includes device registration status.
Identifiers:
- Login with Amazon Scope Name:
portability::kindle_registrations
- Amazon Data Portability
scopeId
:portability-kindle-registrations
Kindle registrations
Schema properties:
Properties | Details | Example value |
---|---|---|
deviceSerialNumber |
Unique serial number identifier for the Kindle device. | 1115FB4AD4D10805 |
customerType |
Type of customer account - either adult or child account. | ADULT |
deviceAccountRole |
Role of the device in the account - primary or secondary device. | PRIMARY |
accountName |
Display name of the account associated with the device. | Anna's Android device |
firstTimeRegistered |
Timestamp when the device was first registered to an account. | 2025-08-21T07:03:23.310Z |
lastTimeRegistered |
Timestamp of the most recent registration event for the device. | 2025-08-21T07:03:23.310Z |
timeDeregistered |
Timestamp when the device was deregistered from the account, or 'Not Available' if still registered. | Not Available |
state |
Current operational state of the device registration. | ACTIVE |
currentFirmwareVersion |
Version number of the firmware currently installed on the device. | 2689890035 |
deviceModel |
Model identifier of the Kindle device. | MicrosoftMDG_RM-1085_12742_Windows_phone |
localTimeOffset |
Time zone offset from UTC for the device's local time. | -8:00 |
ipAddress |
Last known IP address of the device. | 85.76.41.112 |
customerLoginPool |
Authentication pool used for customer login (e.g., Amazon, Enterprise). | Amazon |
devicePairingDetails |
List of device pairing configurations and their status. | N/A |
devicePairingDetails.protocol |
Communication protocol used for device pairing. | Bluetooth |
devicePairingDetails.status |
Current status of the pairing connection. | INACTIVE |
devicePairingDetails.autoPairEnabled |
Whether automatic pairing is enabled for this protocol. | false |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Registration",
"description": "Device registration information of Kindle devices.",
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceSerialNumber": {
"type": "string",
"description": "Unique serial number identifier for the Kindle device."
},
"customerType": {
"type": "string",
"enum": [
"ADULT",
"CHILD"
],
"description": "Type of customer account - either adult or child account."
},
"deviceAccountRole": {
"type": "string",
"enum": [
"PRIMARY",
"SECONDARY"
],
"description": "Role of the device in the account - primary or secondary device."
},
"accountName": {
"type": "string",
"description": "Display name of the account associated with the device."
},
"firstTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the device was first registered to an account."
},
"lastTimeRegistered": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the most recent registration event for the device."
},
"timeDeregistered": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"const": "Not Available"
}
],
"description": "Timestamp when the device was deregistered from the account, or 'Not Available' if still registered."
},
"state": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current operational state of the device registration."
},
"currentFirmwareVersion": {
"type": "string",
"description": "Version number of the firmware currently installed on the device."
},
"deviceModel": {
"type": "string",
"description": "Model identifier of the Kindle device."
},
"localTimeOffset": {
"type": "string",
"description": "Time zone offset from UTC for the device's local time."
},
"ipAddress": {
"type": "string",
"description": "Last known IP address of the device."
},
"customerLoginPool": {
"type": "string",
"description": "Authentication pool used for customer login (e.g., Amazon, Enterprise)."
},
"devicePairingDetails": {
"type": "array",
"description": "List of device pairing configurations and their status.",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"description": "Communication protocol used for device pairing."
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "Current status of the pairing connection."
},
"autoPairEnabled": {
"type": "boolean",
"description": "Whether automatic pairing is enabled for this protocol."
}
},
"required": [
"protocol",
"status",
"autoPairEnabled"
],
"unevaluatedProperties": false
}
}
},
"required": [
"deviceSerialNumber",
"customerType",
"deviceAccountRole",
"accountName",
"firstTimeRegistered",
"lastTimeRegistered",
"timeDeregistered",
"state",
"currentFirmwareVersion",
"deviceModel",
"localTimeOffset",
"ipAddress",
"customerLoginPool"
],
"unevaluatedProperties": false
}
}
Sample data based on the sample schema:
[
{
"deviceSerialNumber": "1115FB4AD4D10805",
"customerType": "ADULT",
"deviceAccountRole": "PRIMARY",
"accountName": "Anna's Android device",
"firstTimeRegistered": "2025-08-21T07:03:23.310Z",
"lastTimeRegistered": "2025-08-21T07:03:23.310Z",
"timeDeregistered": "Not Available",
"state": "ACTIVE",
"currentFirmwareVersion": "2689890035",
"deviceModel": "MicrosoftMDG_RM-1085_12742_Windows_phone",
"localTimeOffset": "-8:00",
"ipAddress": "85.76.41.112",
"customerLoginPool": "Amazon",
"devicePairingDetails": {
"protocol": "Bluetooth",
"status": "INACTIVE",
"autoPairEnabled": false
}
}
]
Kindle setup connections
This scope includes customer's device privacy preferences.
Identifiers:
- Login with Amazon Scope Name:
portability::kindle_setup_connections
- Amazon Data Portability
scopeId
:portability-kindle-setup-connections
Kindle setup connections
Schema properties:
Properties | Details | Example value |
---|---|---|
provisionerDeviceType |
Provisioner device type id | KINDLE |
provisionerDeviceModel |
Provisioner reported Model | AFTEU011 |
provisionerFirmwareVersion |
Provisioner reported Firmware version | 15.5 |
endTime |
Furthest events time stamp/Session End time | 2017-05-06 22:06:04.0 |
provisioneeZigbeeMacAddress |
Provisionee Zigbee MAC Address | 00:17:88:01:XX:XX:XX:XX |
provisioneeWifiMacAddress |
Provisionee Wi-Fi MAC Address | null |
eventDate |
Earliest events time stamp/Session start time | 2017-05-06 22:06:04.0 |
chosenSsidCredentialsChanged |
Indicates if the customer modified the credentials of pre-populated network credentials | Yes |
provisioneeDeviceName |
Provisionee reported device name | Echo Dot-W0J |
provisioneeDeviceModel |
Provisionee reported model | A3VRME03NAXFUB |
deviceSerialNumber |
Provisionee provided Device Serial Number | xxxLF1071771JPX |
provisioneeHardwareVersion |
Provisionee reported hardware version | mt8169 |
provisioneeFriendlyName |
Device friendly name | null |
provisioneeFirmwareVersion |
Provisionee reported firmware version | 7.1.2 |
provisioneeBLEMacAddress |
Provisionee BLE MAC address | C3:A4:D2:D8:DD:DA |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Setup Connections",
"description": "Schema for devices Frustration free set up session details.",
"type": "array",
"items": {
"type": "object",
"required": [
"provisionerDeviceType",
"endTime",
"eventDate",
"deviceSerialNumber"
],
"unevaluatedProperties": false,
"properties": {
"provisionerDeviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Provisioner device type id."
},
"provisionerDeviceModel": {
"type": "string",
"description": "Provisioner reported Model."
},
"provisionerFirmwareVersion": {
"type": "string",
"description": "Provisioner reported Firmware version."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Furthest events time stamp/Session End time."
},
"provisioneeZigbeeMacAddress": {
"type": "string",
"description": "Provisionee Zigbee MAC Address."
},
"provisioneeWifiMacAddress": {
"type": "string",
"description": "Provisionee Wi-Fi MAC Address."
},
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Earliest events time stamp/Session start time"
},
"chosenSsidCredentialsChanged": {
"type": "string",
"enum": [
"Yes",
"No",
"Not Available"
],
"description": "Indicates if the customer modified the credentials of pre-populated network credentials."
},
"provisioneeDeviceName": {
"type": "string",
"description": "Provisionee reported device name."
},
"provisioneeDeviceModel": {
"type": "string",
"description": "Provisionee reported model."
},
"deviceSerialNumber": {
"type": "string",
"description": "Provisionee provided Device Serial Number."
},
"provisioneeHardwareVersion": {
"type": "string",
"description": "Provisionee reported hardware version."
},
"provisioneeFriendlyName": {
"type": "string",
"description": "Device friendly name."
},
"provisioneeFirmwareVersion": {
"type": "string",
"description": "Provisionee reported firmware version."
},
"provisioneeBLEMacAddress": {
"type": "string",
"description": "Provisionee BLE MAC address."
}
}
}
}
Sample data based on the sample schema:
[
{
"provisionerDeviceType": "KINDLE",
"provisionerDeviceModel": "AFTEU011",
"provisionerFirmwareVersion": "15.5",
"endTime": "2017-05-06 22:06:04.0",
"provisioneeZigbeeMacAddress": "00:17:88:01:XX:XX:XX:XX",
"provisioneeWifiMacAddress": null,
"eventDate": "2017-05-06 22:06:04.0",
"chosenSsidCredentialsChanged": "Yes",
"provisioneeDeviceName": "Echo Dot-W0J",
"provisioneeDeviceModel": "A3VRME03NAXFUB",
"deviceSerialNumber": "xxxLF1071771JPX",
"provisioneeHardwareVersion": "mt8169",
"provisioneeFriendlyName": null,
"provisioneeFirmwareVersion": "7.1.2",
"provisioneeBLEMacAddress": "C3:A4:D2:D8:DD:DA"
}
]
Kindle usage metrics
This scope includes customer's customized device settings.
Identifiers:
- Login with Amazon Scope Name:
portability::kindle_usage_metrics
- Amazon Data Portability
scopeId
:portability-kindle-usage-metrics
Kindle usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on a device. | 2025-04-22T21:04:52Z |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type determines the internal identifier for launched device. | KINDLE |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute Inherited from Clickstream. | appAction |
reasonCode |
Describes context of DEM Metric, what triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Usage 3P",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on a device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type determines the internal identifier for launched device."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute Inherited from Clickstream."
},
"reasonCode": {
"type": "string",
"description": "Describes context of DEM Metric, what triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2025-04-22T21:04:52Z",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "KINDLE",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Kindle engagement metrics
This scope includes device activity and setup information.
Identifiers:
- Login with Amazon Scope Name:
portability::kindle_engagement_metrics
- Amazon Data Portability
scopeId
:portability-kindle-engagement-metrics
Device Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
deviceType |
Device type. | KINDLE |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
metricLevel |
Attribute representing the type of metric being measured. | appAction |
reasonCode |
What triggered the metric. | VOICE_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement",
"description": "Device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device"
},
"softwareVersion": {
"type": "string",
"description": "Device software version"
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "What triggered the metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "KINDLE",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_OFF"
}
]
Application Engagement
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device Serial Number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
appPackageName |
Package name of application for which metric is associated. | com.amazon.avod |
appVersionName |
Version of the application for which the metric is associated. | 5.7.3-17 |
appVersionCode |
Numeric value of the application version. | 573001710 |
deviceType |
Device type. | KINDLE |
deviceProfileType |
Profile Type. | Adult |
appProfileType |
Type of App profile. | Adult |
launchCount |
Number of times app has been launched. | 7 |
durationMilliseconds |
Duration of app in use for the metric session in milliseconds. | 901141 |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
metricLevel |
Attribute representing the type of metric being measured. | appAction |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | SHOW_MODE |
reasonCode |
Describes context of metric. | VOICE_OFF |
metricSource |
Device source of metric. | APP |
startTime |
Timestamp when the app launched. | 2017-05-06 22:06:04.0 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "App Engagement",
"description": "Application usage data including device information and app metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"appPackageName": {
"type": "string",
"description": "Package name of application for which metric is associated."
},
"appVersionName": {
"type": "string",
"description": "Version of the application for which the metric is associated."
},
"appVersionCode": {
"type": "string",
"description": "Numeric value of the application version."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device Type"
},
"deviceProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Profile Type."
},
"appProfileType": {
"type": "string",
"enum": [
"Adult",
"Teen"
],
"description": "Type of App profile."
},
"launchCount": {
"type": "string",
"description": "Number of times app has been launched."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of app in use for the metric session in milliseconds."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
},
"metricSource": {
"type": "string",
"description": "Device source of metric."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the app launched."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"appPackageName": "com.amazon.avod",
"appVersionName": "5.7.3-17",
"appVersionCode": "573001710",
"deviceType": "KINDLE",
"deviceProfileType": "Adult",
"appProfileType": "Adult",
"launchCount": "7",
"durationMilliseconds": "901141",
"softwareVersion": "36.5.7.3_user_573210520",
"metricLevel": "appAction",
"productMode": "SHOW_MODE",
"reasonCode": "VOICE_OFF",
"metricSource": "APP",
"startTime": "2017-05-06 22:06:04.0"
}
]
Third-party device usage data including device information and software details
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device serial number. | 0094052161860CT8 |
deviceType |
Device type. | KINDLE |
countryOfResidence |
Country of residence of registered customer using device. | US |
softwareVersion |
Device software version. | 54.5.7.3_user_573210520 |
productMode |
Attribute which specified if device is used in Show mode or Default mode. | DEFAULT |
metricLevel |
Attribute representing the type of metric being measured. | deviceAction |
reasonCode |
Describes context of metric. | VOICE_ON |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement 3p ACK",
"description": "Third-party device usage data including device information and software details.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Device type."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"productMode": {
"type": "string",
"description": "Attribute which specified if device is used in Show mode or Default mode."
},
"metricLevel": {
"type": "string",
"description": "Attribute representing the type of metric being measured."
},
"reasonCode": {
"type": "string",
"description": "Describes context of metric."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "KINDLE",
"countryOfResidence": "US",
"softwareVersion": "54.5.7.3_user_573210520",
"productMode": "SHOW_MODE",
"metricLevel": "appAction",
"reasonCode": "VOICE_ON"
}
]
Out Of Box Experience (OOBE) staging data including device and navigation details
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Device UTC timestamp at the time of recording the event. | 2021-01-08 04:25:53.0 |
deviceSerialNumber |
Device Serial Number. | G001DE4567890D6C |
deviceType |
Describes major device category. | KINDLE |
osVersion |
Device Software Version. | 36.5.7.3_user_573210520 |
deviceSessionId |
Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS). | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSessionId |
App-level session ID, a unique "session" within the app itself. | b7c498dc-c394-4d93-81ed-bbd9d5d4511d |
appSequenceId |
App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1). | 1 |
appPackageName |
The app package name that corresponds to the OOBE step. | com.amazon.oobe |
appVersion |
App version or application used for Out Of Box Experience. | 1.0.207001.0_13065210 |
appProfileType |
Type of App profile. | Adult |
deviceProfile |
Device profile identifier. | com.amazon.oid.AZADASASASAS |
deviceProfileType |
Profile Type. | Adult |
fromPage |
The previous page_id. | OOBE |
toPage |
The next page_id after the current step. | Registration |
currentPage |
Page Name/ID to identify the page. | LanguagePicker |
metricName |
The metric event. | LanguagePickerModule_END |
sequenceId |
High level incrementing sequence id for out of box experience process. | 2 |
eventDurationMilliseconds |
The duration of the event. | 901141 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Device Engagement Metrics",
"description": "Out Of Box Experience (OOBE) staging data including device and navigation details",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"metricName",
"currentPage",
"sequenceId",
"osVersion",
"appSessionId"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Device UTC timestamp at the time of recording the event."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device Serial Number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Describes major device category."
},
"osVersion": {
"type": "string",
"description": "Device Software Version."
},
"deviceSessionId": {
"type": "string",
"description": "Device-level session (this is usually defined at the OS-layer (e.g., FOS/ACS)."
},
"appSessionId": {
"type": "string",
"description": "App-level session ID, a unique 'session' within the app itself."
},
"appSequenceId": {
"type": "string",
"description": "App-level sequence within a particular app-level session (this metric will increase the sequence ID counter by 1)."
},
"appPackageName": {
"type": "string",
"description": "The app package name that corresponds to the OOBE step."
},
"appVersion": {
"type": "string",
"description": "App version or application used for Out Of Box Experience."
},
"appProfileType": {
"type": "string",
"description": "Type of App profile."
},
"deviceProfile": {
"type": "string",
"description": "Device profile identifier."
},
"deviceProfileType": {
"type": "string",
"description": "Profile Type."
},
"fromPage": {
"type": "string",
"description": "The previous page_id."
},
"toPage": {
"type": "string",
"description": "The next page_id after the current step."
},
"currentPage": {
"type": "string",
"description": "Page Name/ID to identify the page."
},
"metricName": {
"type": "string",
"description": "The metric event."
},
"sequenceId": {
"type": "string",
"description": "High level incrementing sequence id for out of box experience process."
},
"eventDurationMilliseconds": {
"type": "string",
"description": "The duration of the event."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2021-01-08 04:25:53.0",
"deviceSerialNumber": "G001DE4567890D6C",
"deviceType": "KINDLE",
"osVersion": "36.5.7.3_user_573210520",
"deviceSessionId": "b7c498dc-c394-4d93-81ed-bbd9d5d4511d",
"appSessionId": "db5801e6-20f1-42b4-ac51-e3b1c4597da3",
"appSequenceId": "0",
"appPackageName": "com.amazon.oobe",
"appVersion": "1.0.207001.0_13065210",
"appProfileType": "Adult",
"deviceProfile": "com.amazon.oid.AZADASASASAS",
"deviceProfileType": "Adult",
"fromPage": "OOBE",
"toPage": "WiFi",
"currentPage": "LanguagePicker",
"metricName": "LanguagePickerModule_END",
"sequenceId": "1",
"eventDurationMilliseconds": "90114"
}
]
Total Usage data including device information and usage metrics
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
Time when a metric is recorded on device. | 2017-05-06 22:06:04.0 |
deviceSerialNumber |
Device serial number. | 0094052161860CT8 |
countryOfResidence |
Country of residence of registered customer using device. | US |
startTime |
When the total usage event was started in timestamp format. | 2017-05-06 22:06:04.0 |
endTime |
When the total usage event was ended in timestamp format. | 2017-05-06 22:06:04.0 |
durationMilliseconds |
Duration of total_usage event in milliseconds. | 901141 |
metricName |
Device metric information. | TOTAL_USAGE |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
triggerType |
When the total usage event ended. | SCREEN_OFF |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage",
"description": "Total usage data including device information and usage metrics.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"durationMilliseconds",
"metricName",
"softwareVersion"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "Time when a metric is recorded on device."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"countryOfResidence": {
"type": "string",
"description": "Country of residence of registered customer using device."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was started in timestamp format."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "When the total usage event was ended in timestamp format."
},
"durationMilliseconds": {
"type": "string",
"description": "Duration of total_usage event in milliseconds."
},
"metricName": {
"type": "string",
"description": "Device metric information."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"triggerType": {
"type": "string",
"description": "When the total usage event ended."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2017-05-06 22:06:04.0",
"deviceSerialNumber": "0094052161860CT8",
"countryOfResidence": "US",
"startTime": "2017-05-06 22:06:04.0",
"endTime": "2017-05-06 22:06:04.0",
"durationMilliseconds": "901141",
"metricName": "TOTAL_USAGE",
"softwareVersion": "36.5.7.3_user_573210520",
"triggerType": "SCREEN_OFF"
}
]
Total Usage rolled up to a per-user/per-device, per-day level
Schema properties:
Properties | Details | Example value |
---|---|---|
eventDate |
The date that has been aggregated to for this set of metrics. | 2025-08-10T00:00:00Z |
deviceSerialNumber |
Device serial number. | 0094052161860CT8 |
deviceType |
Product category. | KINDLE |
asin |
ASIN of the product. | B00KQO3EVM |
softwareVersion |
Device software version. | 36.5.7.3_user_573210520 |
durationMilliseconds |
Total amount of time for a specific metric on the day for the specific device serial number. | 901141 |
powerLossCount |
The number of times a customer powered off the device for the day. | 1 |
Sample schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Total Usage Per Day",
"description": "This table stores total usage rolled up to a per-user/per-device, per-day level.",
"type": "array",
"items": {
"type": "object",
"required": [
"eventDate",
"deviceSerialNumber",
"deviceType",
"softwareVersion",
"durationMilliseconds"
],
"unevaluatedProperties": false,
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"description": "The date that has been aggregated to for this set of metrics."
},
"deviceSerialNumber": {
"type": "string",
"description": "Device serial number."
},
"deviceType": {
"type": "string",
"enum": [
"FIRETV",
"FIRE TABLETS",
"ECHO",
"KINDLE"
],
"description": "Product category."
},
"asin": {
"type": "string",
"description": "ASIN of the product."
},
"softwareVersion": {
"type": "string",
"description": "Device software version."
},
"durationMilliseconds": {
"type": "string",
"description": "Total amount of time for a specific metric on the day for the specific device serial number."
},
"powerLossCount": {
"type": "string",
"description": "The number of times a customer powered off the device for the day."
}
}
}
}
Sample data based on the sample schema:
[
{
"eventDate": "2025-08-10T00:00:00Z",
"deviceSerialNumber": "0094052161860CT8",
"deviceType": "KINDLE",
"asin": "B00KQO3EVM",
"softwareVersion": "36.5.7.3_user_573210520",
"durationMilliseconds": "901141",
"powerLossCount": "1"
}
]
Last updated: Sep 08, 2025