wezone
/
selling-partner-api-models
mirror of https://github.com/amzn/selling-partner-api-models.git
10
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update analytics_salesAndTraffic_2023_11_15

This commit is contained in:
Jack Evoniuk 2024-03-05 14:54:08 -08:00
parent 1dcd1bc78e
commit a0db67eb6c
1 changed files with 147 additions and 266 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

411
schemas/data-kiosk/analytics_salesAndTraffic_2023_11_15.graphql
View File

@ -1,3 +1,7 @@
schema {
query: Query
}
""" """
This directive specifies the retention duration of a query containing a This directive specifies the retention duration of a query containing a
particular field. When a query contains multiple fields with different particular field. When a query contains multiple fields with different
@ -5,44 +9,36 @@ retentions, the shortest (minimum) retention is applied to the query. The
retention of a query's resulting documents always matches the retention of the query. retention of a query's resulting documents always matches the retention of the query.
""" """
directive @resultRetention( directive @resultRetention(
"""An ISO 8601 duration.""" "An ISO 8601 duration."
duration: String! duration: String!
) on FIELD_DEFINITION ) on FIELD_DEFINITION
"""Monetary amount with the corresponding currency code.""" "Monetary amount with the corresponding currency code."
type Amount { type Amount {
"""The amount.""" "The amount."
amount: Float! amount: Float!
"Currency code of the amount in ISO 4217 format."
"""Currency code of the amount in ISO 4217 format."""
currencyCode: String! currencyCode: String!
} }
""" "A root type for Analytics Sales and Traffic queries version 2023_11_15."
A root type for Analytics Sales and Traffic queries version 2023_11_15.
"""
type Analytics_SalesAndTraffic_2023_11_15 { type Analytics_SalesAndTraffic_2023_11_15 {
""" "A query to retrieve sales and traffic data for the seller's account aggregated by ASIN."
A query to retrieve sales and traffic data for the seller's account aggregated by ASIN.
"""
salesAndTrafficByAsin( salesAndTrafficByAsin(
"""Determines how the sales and traffic data should be aggregated.""" "Determines how the sales and traffic data should be aggregated."
aggregateBy: AsinGranularity! aggregateBy: AsinGranularity!,
""" """
The end date of the sales and traffic data to retrieve. If a date The end date of the sales and traffic data to retrieve. If a date
granularity is specified and the provided end date occurs mid-week or granularity is specified and the provided end date occurs mid-week or
mid-month, the preceding Saturday for WEEK date granularity or the last day mid-month, the preceding Saturday for WEEK date granularity or the last day
of the previous month for MONTH date granularity will be used instead. of the previous month for MONTH date granularity will be used instead.
""" """
endDate: Date! endDate: Date!,
""" """
The marketplace identifiers to retrieve sales and traffic data for. If The marketplace identifiers to retrieve sales and traffic data for. If
omitted, sales and traffic data for all applicable marketplaces will be retrieved. omitted, sales and traffic data for all applicable marketplaces will be retrieved.
""" """
marketplaceIds: [String] marketplaceIds: [String],
""" """
The start date of the sales and traffic data to retrieve. The start date The start date of the sales and traffic data to retrieve. The start date
must be no more than two years ago. If a date granularity is specified and must be no more than two years ago. If a date granularity is specified and
@ -52,28 +48,22 @@ type Analytics_SalesAndTraffic_2023_11_15 {
""" """
startDate: Date! startDate: Date!
): [SalesAndTrafficByAsin] ): [SalesAndTrafficByAsin]
"A query to retrieve sales and traffic data for the seller's account aggregated by date."
"""
A query to retrieve sales and traffic data for the seller's account aggregated by date.
"""
salesAndTrafficByDate( salesAndTrafficByDate(
"""Determines how the sales and traffic data should be aggregated.""" "Determines how the sales and traffic data should be aggregated."
aggregateBy: DateGranularity! aggregateBy: DateGranularity!,
""" """
The end date of the sales and traffic data to retrieve. If the provided end The end date of the sales and traffic data to retrieve. If the provided end
date occurs mid-week or mid-month, the preceding Saturday for WEEK date date occurs mid-week or mid-month, the preceding Saturday for WEEK date
granularity or the last day of the previous month for MONTH date granularity granularity or the last day of the previous month for MONTH date granularity
will be used instead. will be used instead.
""" """
endDate: Date! endDate: Date!,
""" """
The marketplace identifiers to retrieve sales and traffic data for. If The marketplace identifiers to retrieve sales and traffic data for. If
omitted, sales and traffic data for all applicable marketplaces will be retrieved. omitted, sales and traffic data for all applicable marketplaces will be retrieved.
""" """
marketplaceIds: [String] marketplaceIds: [String],
""" """
The start date of the sales and traffic data to retrieve. The start date The start date of the sales and traffic data to retrieve. The start date
must be no more than two years ago. If the provided start date occurs must be no more than two years ago. If the provided start date occurs
@ -84,90 +74,76 @@ type Analytics_SalesAndTraffic_2023_11_15 {
): [SalesAndTrafficByDate] ): [SalesAndTrafficByDate]
} }
"""The sales data for the seller's account aggregated by ASIN.""" "The sales data for the seller's account aggregated by ASIN."
type ByAsinSales { type ByAsinSales {
""" """
The amount of ordered product sales, calculated by multiplying the price of The amount of ordered product sales, calculated by multiplying the price of
products and the number of units sold for the selected time period. products and the number of units sold for the selected time period.
""" """
orderedProductSales: Amount! orderedProductSales: Amount! @resultRetention(duration : "P30D")
""" """
The amount of ordered product sales to Amazon Business customers, calculated The amount of ordered product sales to Amazon Business customers, calculated
by multiplying the price of products and the number of units sold for the by multiplying the price of products and the number of units sold for the
selected time period. Note: This field is only populated when the seller is a B2B seller. selected time period. Note: This field is only populated when the seller is a B2B seller.
""" """
orderedProductSalesB2B: Amount orderedProductSalesB2B: Amount @resultRetention(duration : "P30D")
"The number of items that were ordered for the selected time period."
"""The number of items that were ordered for the selected time period.""" totalOrderItems: Long! @resultRetention(duration : "P30D")
totalOrderItems: Long!
""" """
The number of items that were ordered by Amazon Business customers for the The number of items that were ordered by Amazon Business customers for the
selected time period. Note: This field is only populated when the seller is a B2B seller. selected time period. Note: This field is only populated when the seller is a B2B seller.
""" """
totalOrderItemsB2B: Long totalOrderItemsB2B: Long @resultRetention(duration : "P30D")
"The number of units ordered."
"""The number of units ordered.""" unitsOrdered: Long! @resultRetention(duration : "P30D")
unitsOrdered: Long!
""" """
The number of units ordered by Amazon Business customers. Note: This field is The number of units ordered by Amazon Business customers. Note: This field is
only populated when the seller is a B2B seller. only populated when the seller is a B2B seller.
""" """
unitsOrderedB2B: Long unitsOrderedB2B: Long @resultRetention(duration : "P30D")
} }
"""The traffic data for the seller's account aggregated by ASIN.""" "The traffic data for the seller's account aggregated by ASIN."
type ByAsinTraffic { type ByAsinTraffic {
""" "Browser page views are the number of times a user visited your Amazon.com browser pages for the selected time period."
Browser page views are the number of times a user visited your Amazon.com browser pages for the selected time period. browserPageViews: Long! @resultRetention(duration : "P30D")
"""
browserPageViews: Long!
""" """
Browser B2B page views are the number of times an Amazon Business customer Browser B2B page views are the number of times an Amazon Business customer
visited your Amazon.com browser pages for the selected time period. Note: This visited your Amazon.com browser pages for the selected time period. Note: This
field is only populated when the seller is a B2B seller. field is only populated when the seller is a B2B seller.
""" """
browserPageViewsB2B: Long browserPageViewsB2B: Long @resultRetention(duration : "P30D")
""" """
The percentage of browser page views that a particular SKU/ASIN receives The percentage of browser page views that a particular SKU/ASIN receives
relative to the total number of browser page views for all products. relative to the total number of browser page views for all products.
""" """
browserPageViewsPercentage: Float! browserPageViewsPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of browser views by Amazon Business customers that a particular The percentage of browser views by Amazon Business customers that a particular
SKU/ASIN receives relative to the total number of mobile page views by Amazon SKU/ASIN receives relative to the total number of mobile page views by Amazon
Business customers for all products. Note: This field is only populated when Business customers for all products. Note: This field is only populated when
the seller is a B2B seller. the seller is a B2B seller.
""" """
browserPageViewsPercentageB2B: Float browserPageViewsPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
The percentage of browser sessions that contain at least one page view for a The percentage of browser sessions that contain at least one page view for a
particular SKU/ASIN relative to the total number of browser sessions for all products. particular SKU/ASIN relative to the total number of browser sessions for all products.
""" """
browserSessionPercentage: Float! browserSessionPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of browser sessions that contain at least one page view by an The percentage of browser sessions that contain at least one page view by an
Amazon Business customer for a particular SKU/ASIN relative to the total Amazon Business customer for a particular SKU/ASIN relative to the total
number of browser sessions by Amazon Business customers for all products. number of browser sessions by Amazon Business customers for all products.
Note: This field is only populated when the seller is a B2B seller. Note: This field is only populated when the seller is a B2B seller.
""" """
browserSessionPercentageB2B: Float browserSessionPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
Browser sessions are visits to your Amazon.com browser pages by a user. All Browser sessions are visits to your Amazon.com browser pages by a user. All
browser activity within a 24-hour period is considered a browser session. For browser activity within a 24-hour period is considered a browser session. For
example, if a user visits your pages using a browser multiple times within a example, if a user visits your pages using a browser multiple times within a
24 hour period it is counted as a single browser session. 24 hour period it is counted as a single browser session.
""" """
browserSessions: Long! browserSessions: Long! @resultRetention(duration : "P30D")
""" """
Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon
Business customer. All activity within a 24-hour period is considered a Business customer. All activity within a 24-hour period is considered a
@ -175,70 +151,60 @@ type ByAsinTraffic {
using browser multiple times within a 24 hour period it is counted as a single using browser multiple times within a 24 hour period it is counted as a single
session. Note: This field is only populated when the seller is a B2B seller. session. Note: This field is only populated when the seller is a B2B seller.
""" """
browserSessionsB2B: Long browserSessionsB2B: Long @resultRetention(duration : "P30D")
""" """
The percentage of page views where the buy box (the add to shopping cart link) The percentage of page views where the buy box (the add to shopping cart link)
appeared on the page for customers to add your product to their cart. appeared on the page for customers to add your product to their cart.
""" """
buyBoxPercentage: Float! buyBoxPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of page views by Amazon Business customers where the buy box The percentage of page views by Amazon Business customers where the buy box
(the add to shopping cart link) appeared on the page for customers to add your (the add to shopping cart link) appeared on the page for customers to add your
product to their cart. Note: This field is only populated when the seller is a B2B seller. product to their cart. Note: This field is only populated when the seller is a B2B seller.
""" """
buyBoxPercentageB2B: Float buyBoxPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
Mobile app page views are the number of times a user visited your Amazon.com Mobile app page views are the number of times a user visited your Amazon.com
mobile app pages for the selected time period. mobile app pages for the selected time period.
""" """
mobileAppPageViews: Long! mobileAppPageViews: Long! @resultRetention(duration : "P30D")
""" """
Mobile app B2B page views are the number of times an Amazon Business customer Mobile app B2B page views are the number of times an Amazon Business customer
visited your Amazon.com mobile app pages for the selected time period. Note: visited your Amazon.com mobile app pages for the selected time period. Note:
This field is only populated when the seller is a B2B seller. This field is only populated when the seller is a B2B seller.
""" """
mobileAppPageViewsB2B: Long mobileAppPageViewsB2B: Long @resultRetention(duration : "P30D")
""" """
The percentage of mobile app page views that a particular SKU/ASIN receives The percentage of mobile app page views that a particular SKU/ASIN receives
relative to the total number of mobile app page views for all products. relative to the total number of mobile app page views for all products.
""" """
mobileAppPageViewsPercentage: Float! mobileAppPageViewsPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of mobile page views by Amazon Business customers that a The percentage of mobile page views by Amazon Business customers that a
particular SKU/ASIN receives relative to the total number of mobile page views particular SKU/ASIN receives relative to the total number of mobile page views
by Amazon Business customers for all products. Note: This field is only by Amazon Business customers for all products. Note: This field is only
populated when the seller is a B2B seller. populated when the seller is a B2B seller.
""" """
mobileAppPageViewsPercentageB2B: Float mobileAppPageViewsPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
The percentage of mobile app sessions that contain at least one page view for The percentage of mobile app sessions that contain at least one page view for
a particular SKU/ASIN relative to the total number of mobile app sessions for all products. a particular SKU/ASIN relative to the total number of mobile app sessions for all products.
""" """
mobileAppSessionPercentage: Float! mobileAppSessionPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of mobile app sessions that contain at least one page view by The percentage of mobile app sessions that contain at least one page view by
an Amazon Business customer for a particular SKU/ASIN relative to the total an Amazon Business customer for a particular SKU/ASIN relative to the total
number of mobile app sessions by Amazon Business customers for all products. number of mobile app sessions by Amazon Business customers for all products.
Note: This field is only populated when the seller is a B2B seller. Note: This field is only populated when the seller is a B2B seller.
""" """
mobileAppSessionPercentageB2B: Float mobileAppSessionPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
Mobile app sessions are visits to your Amazon.com mobile app pages by a user. Mobile app sessions are visits to your Amazon.com mobile app pages by a user.
All mobile app activity within a 24-hour period is considered a mobile app All mobile app activity within a 24-hour period is considered a mobile app
session. For example, if a user visits your pages using a mobile app multiple session. For example, if a user visits your pages using a mobile app multiple
times within a 24 hour period it is counted as a single mobile app session. times within a 24 hour period it is counted as a single mobile app session.
""" """
mobileAppSessions: Long! mobileAppSessions: Long! @resultRetention(duration : "P30D")
""" """
Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an
Amazon Business customer. All activity within a 24-hour period is considered a Amazon Business customer. All activity within a 24-hour period is considered a
@ -246,57 +212,49 @@ type ByAsinTraffic {
pages using mobile app multiple times within a 24 hour period it is counted as pages using mobile app multiple times within a 24 hour period it is counted as
a single session. Note: This field is only populated when the seller is a B2B seller. a single session. Note: This field is only populated when the seller is a B2B seller.
""" """
mobileAppSessionsB2B: Long mobileAppSessionsB2B: Long @resultRetention(duration : "P30D")
""" """
Page views are the number of times a user visited your Amazon.com browser or Page views are the number of times a user visited your Amazon.com browser or
mobile app pages for the selected time period. It is calculated as the sum of mobile app pages for the selected time period. It is calculated as the sum of
browserPageViews and mobileAppPageViews. browserPageViews and mobileAppPageViews.
""" """
pageViews: Long! pageViews: Long! @resultRetention(duration : "P30D")
""" """
B2B page views are the number of times an Amazon Business customer visited B2B page views are the number of times an Amazon Business customer visited
your Amazon.com pages using browser or mobile app for the selected time your Amazon.com pages using browser or mobile app for the selected time
period. Note: This field is only populated when the seller is a B2B seller. period. Note: This field is only populated when the seller is a B2B seller.
""" """
pageViewsB2B: Long pageViewsB2B: Long @resultRetention(duration : "P30D")
""" """
The percentage of browser and mobile app page views that a particular SKU/ASIN The percentage of browser and mobile app page views that a particular SKU/ASIN
receives relative to the total number of browser and mobile app page views for all products. receives relative to the total number of browser and mobile app page views for all products.
""" """
pageViewsPercentage: Float! pageViewsPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of page views by Amazon Business customers that a particular The percentage of page views by Amazon Business customers that a particular
SKU/ASIN receives relative to the total number of page views by Amazon SKU/ASIN receives relative to the total number of page views by Amazon
Business customers for all products. Note: This field is only populated when Business customers for all products. Note: This field is only populated when
the seller is a B2B seller. the seller is a B2B seller.
""" """
pageViewsPercentageB2B: Float pageViewsPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
The percentage of sessions that contain at least one page view for a The percentage of sessions that contain at least one page view for a
particular SKU/ASIN relative to the total number of sessions for all products. particular SKU/ASIN relative to the total number of sessions for all products.
""" """
sessionPercentage: Float! sessionPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of sessions that contain at least one page view by an Amazon The percentage of sessions that contain at least one page view by an Amazon
Business customer for a particular SKU/ASIN relative to the total number of Business customer for a particular SKU/ASIN relative to the total number of
sessions by Amazon Business customers for all products. Note: This field is sessions by Amazon Business customers for all products. Note: This field is
only populated when the seller is a B2B seller. only populated when the seller is a B2B seller.
""" """
sessionPercentageB2B: Float sessionPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
Sessions are visits to your Amazon.com browser or mobile app pages by a user. Sessions are visits to your Amazon.com browser or mobile app pages by a user.
All browser and mobile app activity within a 24-hour period is considered a All browser and mobile app activity within a 24-hour period is considered a
session. It is calculated as the sum of browserSessions and mobileAppSessions. session. It is calculated as the sum of browserSessions and mobileAppSessions.
""" """
sessions: Long! sessions: Long! @resultRetention(duration : "P30D")
""" """
B2B sessions are visits to your Amazon.com pages using browser or mobile app B2B sessions are visits to your Amazon.com pages using browser or mobile app
by an Amazon Business customer. All activity within a 24-hour period is by an Amazon Business customer. All activity within a 24-hour period is
@ -305,171 +263,138 @@ type ByAsinTraffic {
counted as a single session. Note: This field is only populated when the counted as a single session. Note: This field is only populated when the
seller is a B2B seller. seller is a B2B seller.
""" """
sessionsB2B: Long sessionsB2B: Long @resultRetention(duration : "P30D")
""" """
The percentage conversion metric indicating how many units were purchased The percentage conversion metric indicating how many units were purchased
relative to the number of people who viewed the products, calculated by relative to the number of people who viewed the products, calculated by
dividing unitsOrdered by sessions. dividing unitsOrdered by sessions.
""" """
unitSessionPercentage: Float! unitSessionPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage conversion metric indicating how many units were purchased by The percentage conversion metric indicating how many units were purchased by
Amazon Business customers relative to the number of Amazon Business customers Amazon Business customers relative to the number of Amazon Business customers
who viewed the products, calculated by dividing unitsOrderedB2B by sessions. who viewed the products, calculated by dividing unitsOrderedB2B by sessions.
Note: This field is only populated when the seller is a B2B seller. Note: This field is only populated when the seller is a B2B seller.
""" """
unitSessionPercentageB2B: Float unitSessionPercentageB2B: Float @resultRetention(duration : "P30D")
} }
"""The sales data for the seller's account aggregated by date.""" "The sales data for the seller's account aggregated by date."
type ByDateSales { type ByDateSales {
""" """
The average ordered product sales, calculated by dividing orderedProductSales The average ordered product sales, calculated by dividing orderedProductSales
by totalOrderItems for the selected time period. by totalOrderItems for the selected time period.
""" """
averageSalesPerOrderItem: Amount! averageSalesPerOrderItem: Amount! @resultRetention(duration : "P30D")
""" """
The average ordered product sales to Amazon Business customers, calculated by The average ordered product sales to Amazon Business customers, calculated by
dividing orderedProductSalesB2B by totalOrderItemsB2B for the selected time dividing orderedProductSalesB2B by totalOrderItemsB2B for the selected time
period. Note: This field is only populated when the seller is a B2B seller. period. Note: This field is only populated when the seller is a B2B seller.
""" """
averageSalesPerOrderItemB2B: Amount averageSalesPerOrderItemB2B: Amount @resultRetention(duration : "P30D")
""" """
The average price of the units sold in the selected time period, calculated by The average price of the units sold in the selected time period, calculated by
dividing the orderedProductSales by unitsOrdered for the selected time period. dividing the orderedProductSales by unitsOrdered for the selected time period.
""" """
averageSellingPrice: Amount! averageSellingPrice: Amount! @resultRetention(duration : "P30D")
""" """
The average price of the units sold to Amazon Business customers, calculated The average price of the units sold to Amazon Business customers, calculated
by dividing the orderedProductSalesB2B by unitsOrderedB2B for the selected by dividing the orderedProductSalesB2B by unitsOrderedB2B for the selected
time period. Note: This field is only populated when the seller is a B2B seller. time period. Note: This field is only populated when the seller is a B2B seller.
""" """
averageSellingPriceB2B: Amount averageSellingPriceB2B: Amount @resultRetention(duration : "P30D")
"The average number of units in each order item for the selected time period."
""" averageUnitsPerOrderItem: Float! @resultRetention(duration : "P30D")
The average number of units in each order item for the selected time period.
"""
averageUnitsPerOrderItem: Float!
""" """
The average number of units in each order item ordered by Amazon Business The average number of units in each order item ordered by Amazon Business
customers for the selected time period. Note: This field is only populated customers for the selected time period. Note: This field is only populated
when the seller is a B2B seller. when the seller is a B2B seller.
""" """
averageUnitsPerOrderItemB2B: Float averageUnitsPerOrderItemB2B: Float @resultRetention(duration : "P30D")
"Monetary amount of filed A-to-z guarantee claims."
"""Monetary amount of filed A-to-z guarantee claims.""" claimsAmount: Amount! @resultRetention(duration : "P30D")
claimsAmount: Amount! "The number of A-to-z guarantee claims granted."
claimsGranted: Long! @resultRetention(duration : "P30D")
"""The number of A-to-z guarantee claims granted."""
claimsGranted: Long!
""" """
The amount of ordered product sales, calculated by multiplying the price of The amount of ordered product sales, calculated by multiplying the price of
products and the number of units sold for the selected time period. products and the number of units sold for the selected time period.
""" """
orderedProductSales: Amount! orderedProductSales: Amount! @resultRetention(duration : "P30D")
""" """
The amount of ordered product sales to Amazon Business customers, calculated The amount of ordered product sales to Amazon Business customers, calculated
by multiplying the price of products and the number of units sold for the by multiplying the price of products and the number of units sold for the
selected time period. selected time period.
""" """
orderedProductSalesB2B: Amount orderedProductSalesB2B: Amount @resultRetention(duration : "P30D")
"The number of orders shipped in the selected time period."
"""The number of orders shipped in the selected time period.""" ordersShipped: Long! @resultRetention(duration : "P30D")
ordersShipped: Long!
""" """
The percentage conversion metric indicating how many orders were refunded by The percentage conversion metric indicating how many orders were refunded by
the seller, calculated by dividing unitsOrdered by unitsRefunded in the the seller, calculated by dividing unitsOrdered by unitsRefunded in the
selected time period. selected time period.
""" """
refundRate: Float! refundRate: Float! @resultRetention(duration : "P30D")
"The amount of ordered product sales shipped for the selected time period."
""" shippedProductSales: Amount! @resultRetention(duration : "P30D")
The amount of ordered product sales shipped for the selected time period.
"""
shippedProductSales: Amount!
""" """
The number of items that were ordered for the selected time period. Example: The number of items that were ordered for the selected time period. Example:
For an order containing 2 copies of book A and 3 copies of book B, the number For an order containing 2 copies of book A and 3 copies of book B, the number
of orders is 1, the number of order items is 2 (book A and book B), and the of orders is 1, the number of order items is 2 (book A and book B), and the
number of units is 5 (2 + 3). number of units is 5 (2 + 3).
""" """
totalOrderItems: Long! totalOrderItems: Long! @resultRetention(duration : "P30D")
""" """
The number of items that were ordered by Amazon Business customers for the The number of items that were ordered by Amazon Business customers for the
selected time period. Example: For an order containing 2 copies of book A and selected time period. Example: For an order containing 2 copies of book A and
3 copies of book B, the number of orders is 1, the number of order items is 2 3 copies of book B, the number of orders is 1, the number of order items is 2
(book A and book B), and the number of units is 5 (2 + 3). (book A and book B), and the number of units is 5 (2 + 3).
""" """
totalOrderItemsB2B: Long totalOrderItemsB2B: Long @resultRetention(duration : "P30D")
""" """
The number of units ordered for the selected time period. Example: For an The number of units ordered for the selected time period. Example: For an
order containing 2 copies of book A and 3 copies of book B, the number of order containing 2 copies of book A and 3 copies of book B, the number of
orders is 1, the number of order items is 2 (book A and book B), and the orders is 1, the number of order items is 2 (book A and book B), and the
number of units is 5 (2 + 3). number of units is 5 (2 + 3).
""" """
unitsOrdered: Long! unitsOrdered: Long! @resultRetention(duration : "P30D")
""" """
The number of units ordered by Amazon Business customers for the selected time The number of units ordered by Amazon Business customers for the selected time
period. Example: For an order containing 2 copies of book A and 3 copies of period. Example: For an order containing 2 copies of book A and 3 copies of
book B, the number of orders is 1, the number of order items is 2 (book A and book B, the number of orders is 1, the number of order items is 2 (book A and
book B), and the number of units is 5 (2 + 3). book B), and the number of units is 5 (2 + 3).
""" """
unitsOrderedB2B: Long unitsOrderedB2B: Long @resultRetention(duration : "P30D")
"The number of units refunded in the selected time period."
"""The number of units refunded in the selected time period.""" unitsRefunded: Long! @resultRetention(duration : "P30D")
unitsRefunded: Long! "The number of units shipped in the selected time period."
unitsShipped: Long! @resultRetention(duration : "P30D")
"""The number of units shipped in the selected time period."""
unitsShipped: Long!
} }
"""The traffic data for the seller's account aggregated by date.""" "The traffic data for the seller's account aggregated by date."
type ByDateTraffic { type ByDateTraffic {
""" """
The average number of offers listed for sale in the selected time period. It The average number of offers listed for sale in the selected time period. It
is calculated from the total number of offers and the total number of days in is calculated from the total number of offers and the total number of days in
the selected time period. the selected time period.
""" """
averageOfferCount: Long! averageOfferCount: Long! @resultRetention(duration : "P30D")
"The average number of parent items listed for sale in the selected time period."
""" averageParentItems: Long! @resultRetention(duration : "P30D")
The average number of parent items listed for sale in the selected time period. "Browser page views are the number of times a user visited your Amazon.com browser pages for the selected time period."
""" browserPageViews: Long! @resultRetention(duration : "P30D")
averageParentItems: Long!
"""
Browser page views are the number of times a user visited your Amazon.com browser pages for the selected time period.
"""
browserPageViews: Long!
""" """
Browser B2B page views are the number of times an Amazon Business customer Browser B2B page views are the number of times an Amazon Business customer
visited your Amazon.com browser pages for the selected time period. Note: This visited your Amazon.com browser pages for the selected time period. Note: This
field is only populated when the seller is a B2B seller. field is only populated when the seller is a B2B seller.
""" """
browserPageViewsB2B: Long browserPageViewsB2B: Long @resultRetention(duration : "P30D")
""" """
Browser sessions are visits to your Amazon.com browser pages by a user. All Browser sessions are visits to your Amazon.com browser pages by a user. All
browser activity within a 24-hour period is considered a browser session. For browser activity within a 24-hour period is considered a browser session. For
example, if a user visits your pages using a browser multiple times within a example, if a user visits your pages using a browser multiple times within a
24 hour period it is counted as a single browser session. 24 hour period it is counted as a single browser session.
""" """
browserSessions: Long! browserSessions: Long! @resultRetention(duration : "P30D")
""" """
Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon
Business customer. All activity within a 24-hour period is considered a Business customer. All activity within a 24-hour period is considered a
@ -477,47 +402,38 @@ type ByDateTraffic {
using browser multiple times within a 24 hour period it is counted as a single using browser multiple times within a 24 hour period it is counted as a single
session. Note: This field is only populated when the seller is a B2B seller. session. Note: This field is only populated when the seller is a B2B seller.
""" """
browserSessionsB2B: Long browserSessionsB2B: Long @resultRetention(duration : "P30D")
""" """
The percentage of page views where the buy box (the add to shopping cart link) The percentage of page views where the buy box (the add to shopping cart link)
appeared on the page for customers to add your product to their cart. appeared on the page for customers to add your product to their cart.
""" """
buyBoxPercentage: Float! buyBoxPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage of page views by Amazon Business customers where the buy box The percentage of page views by Amazon Business customers where the buy box
(the add to shopping cart link) appeared on the page for customers to add your (the add to shopping cart link) appeared on the page for customers to add your
product to their cart. Note: This field is only populated when the seller is a B2B seller. product to their cart. Note: This field is only populated when the seller is a B2B seller.
""" """
buyBoxPercentageB2B: Float buyBoxPercentageB2B: Float @resultRetention(duration : "P30D")
"The number of times customers left feedback in the selected time period."
""" feedbackReceived: Long! @resultRetention(duration : "P30D")
The number of times customers left feedback in the selected time period.
"""
feedbackReceived: Long!
""" """
Mobile app page views are the number of times a user visited your Amazon.com Mobile app page views are the number of times a user visited your Amazon.com
mobile app pages for the selected time period. mobile app pages for the selected time period.
""" """
mobileAppPageViews: Long! mobileAppPageViews: Long! @resultRetention(duration : "P30D")
""" """
Mobile app B2B page views are the number of times an Amazon Business customer Mobile app B2B page views are the number of times an Amazon Business customer
visited your Amazon.com mobile app pages for the selected time period. Note: visited your Amazon.com mobile app pages for the selected time period. Note:
This field is only populated when the seller is a B2B seller. This field is only populated when the seller is a B2B seller.
""" """
mobileAppPageViewsB2B: Long mobileAppPageViewsB2B: Long @resultRetention(duration : "P30D")
""" """
Mobile app sessions are visits to your Amazon.com mobile app pages by a user. Mobile app sessions are visits to your Amazon.com mobile app pages by a user.
All mobile app activity within a 24-hour period is considered a mobile app All mobile app activity within a 24-hour period is considered a mobile app
session. For example, if a user visits your pages using a mobile app multiple session. For example, if a user visits your pages using a mobile app multiple
times within a 24 hour period it is counted as a single mobile app session. times within a 24 hour period it is counted as a single mobile app session.
""" """
mobileAppSessions: Long! mobileAppSessions: Long! @resultRetention(duration : "P30D")
""" """
Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an
Amazon Business customer. All activity within a 24-hour period is considered a Amazon Business customer. All activity within a 24-hour period is considered a
@ -525,54 +441,44 @@ type ByDateTraffic {
pages using mobile app multiple times within a 24 hour period it is counted as pages using mobile app multiple times within a 24 hour period it is counted as
a single session. Note: This field is only populated when the seller is a B2B seller. a single session. Note: This field is only populated when the seller is a B2B seller.
""" """
mobileAppSessionsB2B: Long mobileAppSessionsB2B: Long @resultRetention(duration : "P30D")
"The number of times customers left negative feedback in the selected time period."
""" negativeFeedbackReceived: Long! @resultRetention(duration : "P30D")
The number of times customers left negative feedback in the selected time period.
"""
negativeFeedbackReceived: Long!
""" """
The percentage conversion metric indicating how many order items were The percentage conversion metric indicating how many order items were
generated relative to the number of people who viewed the products. generated relative to the number of people who viewed the products.
""" """
orderItemSessionPercentage: Float! orderItemSessionPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage conversion metric indicating how many order items were The percentage conversion metric indicating how many order items were
generated by Amazon Business customers relative to the number of Amazon generated by Amazon Business customers relative to the number of Amazon
Business customers who viewed the products. Note: This field is only populated Business customers who viewed the products. Note: This field is only populated
when the seller is a B2B seller. when the seller is a B2B seller.
""" """
orderItemSessionPercentageB2B: Float orderItemSessionPercentageB2B: Float @resultRetention(duration : "P30D")
""" """
Page views are the number of times a user visited your Amazon.com browser or Page views are the number of times a user visited your Amazon.com browser or
mobile app pages for the selected time period. It is calculated as the sum of mobile app pages for the selected time period. It is calculated as the sum of
browserPageViews and mobileAppPageViews. browserPageViews and mobileAppPageViews.
""" """
pageViews: Long! pageViews: Long! @resultRetention(duration : "P30D")
""" """
B2B page views are the number of times an Amazon Business customer visited B2B page views are the number of times an Amazon Business customer visited
your Amazon.com pages using browser or mobile app for the selected time your Amazon.com pages using browser or mobile app for the selected time
period. Note: This field is only populated when the seller is a B2B seller. period. Note: This field is only populated when the seller is a B2B seller.
""" """
pageViewsB2B: Long pageViewsB2B: Long @resultRetention(duration : "P30D")
""" """
The negative feedback rate is the number of orders that have received negative The negative feedback rate is the number of orders that have received negative
feedback divided by the number of orders in the selected time period. feedback divided by the number of orders in the selected time period.
""" """
receivedNegativeFeedbackRate: Float! receivedNegativeFeedbackRate: Float! @resultRetention(duration : "P30D")
""" """
Sessions are visits to your Amazon.com browser or mobile app pages by a user. Sessions are visits to your Amazon.com browser or mobile app pages by a user.
All browser and mobile app activity within a 24-hour period is considered a All browser and mobile app activity within a 24-hour period is considered a
session. It is calculated as the sum of browserSessions and mobileAppSessions. session. It is calculated as the sum of browserSessions and mobileAppSessions.
""" """
sessions: Long! sessions: Long! @resultRetention(duration : "P30D")
""" """
B2B sessions are visits to your Amazon.com pages using browser or mobile app B2B sessions are visits to your Amazon.com pages using browser or mobile app
by an Amazon Business customer. All activity within a 24-hour period is by an Amazon Business customer. All activity within a 24-hour period is
@ -581,31 +487,27 @@ type ByDateTraffic {
counted as a single session. Note: This field is only populated when the counted as a single session. Note: This field is only populated when the
seller is a B2B seller. seller is a B2B seller.
""" """
sessionsB2B: Long sessionsB2B: Long @resultRetention(duration : "P30D")
""" """
The percentage conversion metric indicating how many units were purchased The percentage conversion metric indicating how many units were purchased
relative to the number of people who viewed the products. relative to the number of people who viewed the products.
""" """
unitSessionPercentage: Float! unitSessionPercentage: Float! @resultRetention(duration : "P30D")
""" """
The percentage conversion metric indicating how many units were purchased by The percentage conversion metric indicating how many units were purchased by
Amazon Business customers relative to number of Amazon Business customers who Amazon Business customers relative to number of Amazon Business customers who
viewed the products. Note: This field is only populated when the seller is a B2B seller. viewed the products. Note: This field is only populated when the seller is a B2B seller.
""" """
unitSessionPercentageB2B: Float unitSessionPercentageB2B: Float @resultRetention(duration : "P30D")
} }
"""A root type for queries""" "A root type for queries"
type Query { type Query {
"""Analytics Sales and Traffic queries version 2023_11_15.""" "Analytics Sales and Traffic queries version 2023_11_15."
analytics_salesAndTraffic_2023_11_15: Analytics_SalesAndTraffic_2023_11_15 analytics_salesAndTraffic_2023_11_15: Analytics_SalesAndTraffic_2023_11_15
} }
""" "The sales and traffic data for the seller's account aggregated by ASIN."
The sales and traffic data for the seller's account aggregated by ASIN.
"""
type SalesAndTrafficByAsin { type SalesAndTrafficByAsin {
""" """
The Amazon Standard Identification Number of the child product. Child products The Amazon Standard Identification Number of the child product. Child products
@ -613,87 +515,66 @@ type SalesAndTrafficByAsin {
non-sellable parent product. Note: This field is only present when ASIN non-sellable parent product. Note: This field is only present when ASIN
aggregation is CHILD or SKU. aggregation is CHILD or SKU.
""" """
childAsin: String childAsin: String @resultRetention(duration : "P30D")
"The end date of the period of the aggregated data."
"""The end date of the period of the aggregated data.""" endDate: Date! @resultRetention(duration : "P30D")
endDate: Date! "The marketplace identifier of the sales and traffic data."
marketplaceId: String! @resultRetention(duration : "P30D")
"""The marketplace identifier of the sales and traffic data."""
marketplaceId: String!
""" """
The Amazon Standard Identification Number of the parent product. A parent The Amazon Standard Identification Number of the parent product. A parent
product appears in our catalog as a non-buyable, generic identifier for a product appears in our catalog as a non-buyable, generic identifier for a
product that has buyable variations (child products). product that has buyable variations (child products).
""" """
parentAsin: String! parentAsin: String! @resultRetention(duration : "P30D")
"The sales data for the parentAsin/childAsin/sku within the specified date range."
"""
The sales data for the parentAsin/childAsin/sku within the specified date range.
"""
sales: ByAsinSales! sales: ByAsinSales!
""" """
The Stock Keeping Unit of the product. The SKU is a seller specific product The Stock Keeping Unit of the product. The SKU is a seller specific product
identifier. Note: This field is only present when ASIN aggregation is SKU. identifier. Note: This field is only present when ASIN aggregation is SKU.
""" """
sku: String sku: String @resultRetention(duration : "P30D")
"The start date of the period of the aggregated data."
"""The start date of the period of the aggregated data.""" startDate: Date! @resultRetention(duration : "P30D")
startDate: Date! "The traffic data for the parentAsin/childAsin/sku within the specified date range."
"""
The traffic data for the parentAsin/childAsin/sku within the specified date range.
"""
traffic: ByAsinTraffic! traffic: ByAsinTraffic!
} }
""" "The sales and traffic data for the seller's account aggregated by date."
The sales and traffic data for the seller's account aggregated by date.
"""
type SalesAndTrafficByDate { type SalesAndTrafficByDate {
"""The end date of the sales and traffic data.""" "The end date of the sales and traffic data."
endDate: Date! endDate: Date! @resultRetention(duration : "P30D")
"The marketplace identifier of the sales and traffic data."
"""The marketplace identifier of the sales and traffic data.""" marketplaceId: String! @resultRetention(duration : "P30D")
marketplaceId: String! "The sales data for the seller's account."
"""The sales data for the seller's account."""
sales: ByDateSales! sales: ByDateSales!
"The start date of the sales and traffic data."
"""The start date of the sales and traffic data.""" startDate: Date! @resultRetention(duration : "P30D")
startDate: Date! "The traffic data for the seller's account."
"""The traffic data for the seller's account."""
traffic: ByDateTraffic! traffic: ByDateTraffic!
} }
"""The ASIN granularity used in aggregation.""" "The ASIN granularity used in aggregation."
enum AsinGranularity { enum AsinGranularity {
"""Sales and traffic data is aggregated by child ASIN.""" "Sales and traffic data is aggregated by child ASIN."
CHILD CHILD
"Sales and traffic data is aggregated by parent ASIN."
"""Sales and traffic data is aggregated by parent ASIN."""
PARENT PARENT
"Sales and traffic data is aggregated by sku."
"""Sales and traffic data is aggregated by sku."""
SKU SKU
} }
"""The date granularity used in aggregation.""" "The date granularity used in aggregation."
enum DateGranularity { enum DateGranularity {
"""Sales and traffic data is aggregated by day.""" "Sales and traffic data is aggregated by day."
DAY DAY
"Sales and traffic data is aggregated by month."
"""Sales and traffic data is aggregated by month."""
MONTH MONTH
"Sales and traffic data is aggregated by week."
"""Sales and traffic data is aggregated by week."""
WEEK WEEK
} }
"""Date""" "Date"
scalar Date scalar Date
"""Long""" "Long"
scalar Long scalar Long