2024-03-06 06:54:08 +08:00
schema {
query : Query
}
2023-11-17 08:53:21 +08:00
"""
This directive specifies the retention duration of a query containing a
particular field . When a query contains multiple fields with different
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 .
"""
directive @resultRetention (
2024-05-10 02:28:47 +08:00
"An ISO 8601 duration."
duration : String !
) on FIELD_DEFINITION
2023-11-17 08:53:21 +08:00
2024-03-06 06:54:08 +08:00
"Monetary amount with the corresponding currency code."
2023-11-17 08:53:21 +08:00
type Amount {
2024-03-06 06:54:08 +08:00
"The amount."
2023-11-17 08:53:21 +08:00
amount : Float !
2024-03-06 06:54:08 +08:00
"Currency code of the amount in ISO 4217 format."
2023-11-17 08:53:21 +08:00
currencyCode : String !
}
2024-03-06 06:54:08 +08:00
"A root type for Analytics Sales and Traffic queries version 2023_11_15."
2023-11-17 08:53:21 +08:00
type Analytics_SalesAndTraffic_2023_11_15 {
2024-03-06 06:54:08 +08:00
"A query to retrieve sales and traffic data for the seller's account aggregated by ASIN."
2023-11-17 08:53:21 +08:00
salesAndTrafficByAsin (
2024-03-06 06:54:08 +08:00
"Determines how the sales and traffic data should be aggregated."
2024-05-10 02:28:47 +08:00
aggregateBy : AsinGranularity ! ,
2023-11-17 08:53:21 +08:00
"""
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
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 .
"""
2024-05-10 02:28:47 +08:00
endDate : Date ! ,
2023-11-17 08:53:21 +08:00
"""
The marketplace identifiers to retrieve sales and traffic data for . If
omitted , sales and traffic data for all applicable marketplaces will be retrieved .
"""
2024-05-10 02:28:47 +08:00
marketplaceIds : [ String ] ,
2023-11-17 08:53:21 +08:00
"""
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
the provided start date occurs mid - week or mid - month , the following Sunday
for WEEK date granularity or the first day of the next month for MONTH date
granularity will be used instead .
"""
startDate : Date !
2024-06-26 05:41:24 +08:00
) : [ SalesAndTrafficByAsin ] @deprecated ( reason : "No longer supported. Use salesAndTrafficByAsin from the analytics_salesAndTraffic_2024_04_24 schema instead." )
2024-03-06 06:54:08 +08:00
"A query to retrieve sales and traffic data for the seller's account aggregated by date."
2023-11-17 08:53:21 +08:00
salesAndTrafficByDate (
2024-03-06 06:54:08 +08:00
"Determines how the sales and traffic data should be aggregated."
2024-05-10 02:28:47 +08:00
aggregateBy : DateGranularity ! ,
2023-11-17 08:53:21 +08:00
"""
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
granularity or the last day of the previous month for MONTH date granularity
will be used instead .
"""
2024-05-10 02:28:47 +08:00
endDate : Date ! ,
2023-11-17 08:53:21 +08:00
"""
The marketplace identifiers to retrieve sales and traffic data for . If
omitted , sales and traffic data for all applicable marketplaces will be retrieved .
"""
2024-05-10 02:28:47 +08:00
marketplaceIds : [ String ] ,
2023-11-17 08:53:21 +08:00
"""
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
mid - week or mid - month , the following Sunday for WEEK date granularity or the
first day of the next month for MONTH date granularity will be used instead .
"""
startDate : Date !
2024-06-26 05:41:24 +08:00
) : [ SalesAndTrafficByDate ] @deprecated ( reason : "No longer supported. Use salesAndTrafficByDate from the analytics_salesAndTraffic_2024_04_24 schema instead." )
2023-11-17 08:53:21 +08:00
}
2024-03-06 06:54:08 +08:00
"The sales data for the seller's account aggregated by ASIN."
2023-11-17 08:53:21 +08:00
type ByAsinSales {
"""
The amount of ordered product sales , calculated by multiplying the price of
products and the number of units sold for the selected time period .
"""
2024-03-06 06:54:08 +08:00
orderedProductSales : Amount ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
selected time period . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
orderedProductSalesB2B : Amount @resultRetention ( duration : "P30D" )
"The number of items that were ordered for the selected time period."
totalOrderItems : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The number of items that were ordered by Amazon Business customers for the
selected time period . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
totalOrderItemsB2B : Long @resultRetention ( duration : "P30D" )
"The number of units ordered."
unitsOrdered : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The number of units ordered by Amazon Business customers . Note : This field is
on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
unitsOrderedB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
}
2024-03-06 06:54:08 +08:00
"The traffic data for the seller's account aggregated by ASIN."
2023-11-17 08:53:21 +08:00
type ByAsinTraffic {
2024-03-06 06:54:08 +08:00
"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" )
2023-11-17 08:53:21 +08:00
"""
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
field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
browserPageViewsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage of browser page views that a particular SKU / ASIN receives
relative to the total number of browser page views for all products .
"""
2024-03-06 06:54:08 +08:00
browserPageViewsPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
Business customers for all products . Note : This field is on ly populated when
the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
browserPageViewsPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage of browser sessions that contain at least on e page view for a
particular SKU / ASIN relative to the total number of browser sessions for all products .
"""
2024-03-06 06:54:08 +08:00
browserSessionPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage of browser sessions that contain at least on e page view by an
Amazon Business customer for a particular SKU / ASIN relative to the total
number of browser sessions by Amazon Business customers for all products .
Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
browserSessionPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
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 .
"""
2024-03-06 06:54:08 +08:00
browserSessions : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
browser session . For example , if an Amazon Business customer visits your pages
using browser multiple times within a 24 hour period it is counted as a single
session . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
browserSessionsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 .
"""
2024-03-06 06:54:08 +08:00
buyBoxPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
product to their cart . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
buyBoxPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
Mobile app page views are the number of times a user visited your Amazon . com
mobile app pages for the selected time period .
"""
2024-03-06 06:54:08 +08:00
mobileAppPageViews : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 :
This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
mobileAppPageViewsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 .
"""
2024-03-06 06:54:08 +08:00
mobileAppPageViewsPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
by Amazon Business customers for all products . Note : This field is on ly
populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
mobileAppPageViewsPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage of mobile app sessions that contain at least on e page view for
a particular SKU / ASIN relative to the total number of mobile app sessions for all products .
"""
2024-03-06 06:54:08 +08:00
mobileAppSessionPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage of mobile app sessions that contain at least on e page view by
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 .
Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
mobileAppSessionPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
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 .
"""
2024-03-06 06:54:08 +08:00
mobileAppSessions : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
mobile app session . For example , if an Amazon Business customer visits your
pages using mobile app multiple times within a 24 hour period it is counted as
a single session . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
mobileAppSessionsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
browserPageViews and mobileAppPageViews .
"""
2024-03-06 06:54:08 +08:00
pageViews : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
period . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
pageViewsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 .
"""
2024-03-06 06:54:08 +08:00
pageViewsPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
Business customers for all products . Note : This field is on ly populated when
the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
pageViewsPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage of sessions that contain at least on e page view for a
particular SKU / ASIN relative to the total number of sessions for all products .
"""
2024-03-06 06:54:08 +08:00
sessionPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage of sessions that contain at least on e page view by an Amazon
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
on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
sessionPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
session . It is calculated as the sum of browserSessions and mobileAppSessions .
"""
2024-03-06 06:54:08 +08:00
sessions : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
considered a session . For example , if an Amazon Business customer visits your
pages multiple times using mobile app or browser within a 24 hour period it is
counted as a single session . Note : This field is on ly populated when the
seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
sessionsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage conversion metric indicating how many units were purchased
relative to the number of people who viewed the products , calculated by
dividing unitsOrdered by sessions .
"""
2024-03-06 06:54:08 +08:00
unitSessionPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage conversion metric indicating how many units were purchased by
Amazon Business customers relative to the number of Amazon Business customers
who viewed the products , calculated by dividing unitsOrderedB2B by sessions .
Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
unitSessionPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
}
2024-03-06 06:54:08 +08:00
"The sales data for the seller's account aggregated by date."
2023-11-17 08:53:21 +08:00
type ByDateSales {
"""
The average ordered product sales , calculated by dividing orderedProductSales
by totalOrderItems for the selected time period .
"""
2024-03-06 06:54:08 +08:00
averageSalesPerOrderItem : Amount ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The average ordered product sales to Amazon Business customers , calculated by
dividing orderedProductSalesB2B by totalOrderItemsB2B for the selected time
period . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
averageSalesPerOrderItemB2B : Amount @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The average price of the units sold in the selected time period , calculated by
dividing the orderedProductSales by unitsOrdered for the selected time period .
"""
2024-03-06 06:54:08 +08:00
averageSellingPrice : Amount ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The average price of the units sold to Amazon Business customers , calculated
by dividing the orderedProductSalesB2B by unitsOrderedB2B for the selected
time period . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
averageSellingPriceB2B : Amount @resultRetention ( duration : "P30D" )
"The average number of units in each order item for the selected time period."
averageUnitsPerOrderItem : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The average number of units in each order item ordered by Amazon Business
customers for the selected time period . Note : This field is on ly populated
when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
averageUnitsPerOrderItemB2B : Float @resultRetention ( duration : "P30D" )
"Monetary amount of filed A-to-z guarantee claims."
claimsAmount : Amount ! @resultRetention ( duration : "P30D" )
"The number of A-to-z guarantee claims granted."
claimsGranted : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The amount of ordered product sales , calculated by multiplying the price of
products and the number of units sold for the selected time period .
"""
2024-03-06 06:54:08 +08:00
orderedProductSales : Amount ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
selected time period .
"""
2024-03-06 06:54:08 +08:00
orderedProductSalesB2B : Amount @resultRetention ( duration : "P30D" )
"The number of orders shipped in the selected time period."
ordersShipped : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage conversion metric indicating how many orders were refunded by
the seller , calculated by dividing unitsOrdered by unitsRefunded in the
selected time period .
"""
2024-03-06 06:54:08 +08:00
refundRate : Float ! @resultRetention ( duration : "P30D" )
"The amount of ordered product sales shipped for the selected time period."
shippedProductSales : Amount ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
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 ) .
"""
2024-03-06 06:54:08 +08:00
totalOrderItems : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
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 ) .
"""
2024-03-06 06:54:08 +08:00
totalOrderItemsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
orders is 1 , the number of order items is 2 ( book A and book B ) , and the
number of units is 5 ( 2 + 3 ) .
"""
2024-03-06 06:54:08 +08:00
unitsOrdered : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
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 ) .
"""
2024-03-06 06:54:08 +08:00
unitsOrderedB2B : Long @resultRetention ( duration : "P30D" )
"The number of units refunded in the selected time period."
unitsRefunded : Long ! @resultRetention ( duration : "P30D" )
"The number of units shipped in the selected time period."
unitsShipped : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
}
2024-03-06 06:54:08 +08:00
"The traffic data for the seller's account aggregated by date."
2023-11-17 08:53:21 +08:00
type ByDateTraffic {
"""
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
the selected time period .
"""
2024-03-06 06:54:08 +08:00
averageOfferCount : Long ! @resultRetention ( duration : "P30D" )
"The average number of parent items listed for sale in the selected time period."
averageParentItems : Long ! @resultRetention ( duration : "P30D" )
"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" )
2023-11-17 08:53:21 +08:00
"""
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
field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
browserPageViewsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
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 .
"""
2024-03-06 06:54:08 +08:00
browserSessions : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
browser session . For example , if an Amazon Business customer visits your pages
using browser multiple times within a 24 hour period it is counted as a single
session . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
browserSessionsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 .
"""
2024-03-06 06:54:08 +08:00
buyBoxPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
product to their cart . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
buyBoxPercentageB2B : Float @resultRetention ( duration : "P30D" )
"The number of times customers left feedback in the selected time period."
feedbackReceived : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
Mobile app page views are the number of times a user visited your Amazon . com
mobile app pages for the selected time period .
"""
2024-03-06 06:54:08 +08:00
mobileAppPageViews : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 :
This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
mobileAppPageViewsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
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 .
"""
2024-03-06 06:54:08 +08:00
mobileAppSessions : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
mobile app session . For example , if an Amazon Business customer visits your
pages using mobile app multiple times within a 24 hour period it is counted as
a single session . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
mobileAppSessionsB2B : Long @resultRetention ( duration : "P30D" )
"The number of times customers left negative feedback in the selected time period."
negativeFeedbackReceived : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage conversion metric indicating how many order items were
generated relative to the number of people who viewed the products .
"""
2024-03-06 06:54:08 +08:00
orderItemSessionPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage conversion metric indicating how many order items were
generated by Amazon Business customers relative to the number of Amazon
Business customers who viewed the products . Note : This field is on ly populated
when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
orderItemSessionPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
browserPageViews and mobileAppPageViews .
"""
2024-03-06 06:54:08 +08:00
pageViews : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
period . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
pageViewsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 .
"""
2024-03-06 06:54:08 +08:00
receivedNegativeFeedbackRate : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
session . It is calculated as the sum of browserSessions and mobileAppSessions .
"""
2024-03-06 06:54:08 +08:00
sessions : Long ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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
considered a session . For example , if an Amazon Business customer visits your
pages multiple times using mobile app or browser within a 24 hour period it is
counted as a single session . Note : This field is on ly populated when the
seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
sessionsB2B : Long @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage conversion metric indicating how many units were purchased
relative to the number of people who viewed the products .
"""
2024-03-06 06:54:08 +08:00
unitSessionPercentage : Float ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
The percentage conversion metric indicating how many units were purchased by
Amazon Business customers relative to number of Amazon Business customers who
viewed the products . Note : This field is on ly populated when the seller is a B2B seller .
"""
2024-03-06 06:54:08 +08:00
unitSessionPercentageB2B : Float @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
}
2024-03-06 06:54:08 +08:00
"A root type for queries"
2023-11-17 08:53:21 +08:00
type Query {
2024-03-06 06:54:08 +08:00
"Analytics Sales and Traffic queries version 2023_11_15."
2024-06-26 05:41:24 +08:00
analytics_salesAndTraffic_2023_11_15 : Analytics_SalesAndTraffic_2023_11_15 @deprecated ( reason : "No longer supported. Use analytics_salesAndTraffic_2024_04_24 instead." )
2023-11-17 08:53:21 +08:00
}
2024-03-06 06:54:08 +08:00
"The sales and traffic data for the seller's account aggregated by ASIN."
2023-11-17 08:53:21 +08:00
type SalesAndTrafficByAsin {
"""
The Amazon Standard Identification Number of the child product . Child products
are unique , sellable products that are related in our catalog to a single ,
non - sellable parent product . Note : This field is on ly present when ASIN
aggregation is CHILD or SKU .
"""
2024-03-06 06:54:08 +08:00
childAsin : String @resultRetention ( duration : "P30D" )
"The end date of the period of the aggregated data."
endDate : Date ! @resultRetention ( duration : "P30D" )
"The marketplace identifier of the sales and traffic data."
marketplaceId : String ! @resultRetention ( duration : "P30D" )
2023-11-17 08:53:21 +08:00
"""
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 that has buyable variations ( child products ) .
"""
2024-03-06 06:54:08 +08:00
parentAsin : String ! @resultRetention ( duration : "P30D" )
"The sales data for the parentAsin/childAsin/sku within the specified date range."
2023-11-17 08:53:21 +08:00
sales : ByAsinSales !
"""
The Stock Keeping Unit of the product . The SKU is a seller specific product
identifier . Note : This field is on ly present when ASIN aggregation is SKU .
"""
2024-03-06 06:54:08 +08:00
sku : String @resultRetention ( duration : "P30D" )
"The start date of the period of the aggregated data."
startDate : Date ! @resultRetention ( duration : "P30D" )
"The traffic data for the parentAsin/childAsin/sku within the specified date range."
2023-11-17 08:53:21 +08:00
traffic : ByAsinTraffic !
}
2024-03-06 06:54:08 +08:00
"The sales and traffic data for the seller's account aggregated by date."
2023-11-17 08:53:21 +08:00
type SalesAndTrafficByDate {
2024-03-06 06:54:08 +08:00
"The end date of the sales and traffic data."
endDate : Date ! @resultRetention ( duration : "P30D" )
"The marketplace identifier of the sales and traffic data."
marketplaceId : String ! @resultRetention ( duration : "P30D" )
"The sales data for the seller's account."
2023-11-17 08:53:21 +08:00
sales : ByDateSales !
2024-03-06 06:54:08 +08:00
"The start date of the sales and traffic data."
startDate : Date ! @resultRetention ( duration : "P30D" )
"The traffic data for the seller's account."
2023-11-17 08:53:21 +08:00
traffic : ByDateTraffic !
}
2024-03-06 06:54:08 +08:00
"The ASIN granularity used in aggregation."
2023-11-17 08:53:21 +08:00
enum AsinGranularity {
2024-03-06 06:54:08 +08:00
"Sales and traffic data is aggregated by child ASIN."
2023-11-17 08:53:21 +08:00
CHILD
2024-03-06 06:54:08 +08:00
"Sales and traffic data is aggregated by parent ASIN."
2023-11-17 08:53:21 +08:00
PARENT
2024-03-06 06:54:08 +08:00
"Sales and traffic data is aggregated by sku."
2023-11-17 08:53:21 +08:00
SKU
}
2024-03-06 06:54:08 +08:00
"The date granularity used in aggregation."
2023-11-17 08:53:21 +08:00
enum DateGranularity {
2024-03-06 06:54:08 +08:00
"Sales and traffic data is aggregated by day."
2023-11-17 08:53:21 +08:00
DAY
2024-03-06 06:54:08 +08:00
"Sales and traffic data is aggregated by month."
2023-11-17 08:53:21 +08:00
MONTH
2024-03-06 06:54:08 +08:00
"Sales and traffic data is aggregated by week."
2023-11-17 08:53:21 +08:00
WEEK
}
2024-05-10 02:28:47 +08:00
"An RFC-3339 compliant Full Date Scalar. Example: \"2023-11-15\""
2023-11-17 08:53:21 +08:00
scalar Date
2024-05-10 02:28:47 +08:00
"A Scalar for the primitive long type."
2024-03-06 06:54:08 +08:00
scalar Long