List Per-Product reports

GET

/openapi/publisher/v1/reports/details

List per product reports within a date range [start, end]. Filter by asin, productId, linkId or sourceId.The difference in time between the start date and end date can be no longer than 1 year. Dates must be specified in ISO format with no offset (UTC), format: yyyy-MM-ddTHH:mm:ss.SSSZ.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.artemisads.com/openapi/publisher/v1/reports/details?marketplace=amazon.com&start=2025-01-01T08:00:00.000Z&end=2025-05-31T08:00:00.000Z&asins=B0DGXXWGNQ,B0DG8PZSCY&productIds=aa_86Rf07xd4ztfA13R,aa_afRa9dxd4ztfA123&linkIds=aa_uFNqjbUyGoMAU4FM, aa_Dlv1t7DuLkZcvwdj&sourceIds=aa_86Rf07xd4ztfA13R,aa_86Rf07xd4ztfA2Ud&limit=100&cursor=86Rf07xd4ztfA2ztfA' \
--header 'x-aa-authorization: Bearer aa.oa2.v1.xxx'

Response Example

{
  "reports": [
    {
      "marketplace": "",
      "date": "",
      "currency": "",
      "detailPageViews": 0,
      "addToCarts": 0,
      "conversions": 0,
      "sales": 0.0,
      "directDetailPageViews": 0,
      "directAddToCarts": 0,
      "directConversions": 0,
      "directSales": 0.0,
      "haloDetailPageViews": 0,
      "haloAddToCarts": 0,
      "haloConversions": 0,
      "haloSales": 0.0,
      "commissionEarned": 0.0,
      "productId": "",
      "asin": "",
      "productTitle": "",
      "productImageUrl": "",
      "link": {
        "linkId": "",
        "productId": "",
        "asin": "",
        "sourceId": "",
        "sourceName": "",
        "marketplace": "",
        "productStatus": "",
        "trackingLink": "",
        "shortTrackingLink": ""
      },
      "finalized": false
    }
  ],
  "cursor": ""
}

Request

Query Params

marketplace

string

required

Represents an Amazon marketplace. Available options: amazon.com, amazon.co.uk, amazon.ca, amazon.de, amazon.fr

Example:

amazon.com

start

string

required

Start date in ISO format with no offset (UTC). Format: yyyy-MM-ddTHH:mm:ss.SSSZ. The difference between start and end date cannot exceed 1 year.

Example:

2025-01-01T08:00:00.000Z

end

string

required

End date in ISO format with no offset (UTC). Format: yyyy-MM-ddTHH:mm:ss.SSSZ. The difference between start and end date cannot exceed 1 year.

Example:

2025-05-31T08:00:00.000Z

asins

string

optional

Comma-delimited list of ASINs representing an array.

Example:

B0DGXXWGNQ,B0DG8PZSCY

productIds

string

optional

Comma-delimited list of ArtemisAds Product Identifier representing an array.

Example:

aa_86Rf07xd4ztfA13R,aa_afRa9dxd4ztfA123

linkIds

string

optional

Comma-delimited list of ArtemisAds Identifier Link Identifier representing an array.

Example:

aa_uFNqjbUyGoMAU4FM, aa_Dlv1t7DuLkZcvwdj

sourceIds

string

optional

Comma-delimited list of ArtemisAds Publisher Source Identifier representing an array.

Example:

aa_86Rf07xd4ztfA13R,aa_86Rf07xd4ztfA2Ud

limit

integer

optional

Maximum number of items to return in the response, default is 100.

Example:

100

cursor

string

optional

The cursor returned from the last request, if omitted the first page will be returned.

Example:

86Rf07xd4ztfA2ztfA

Header Params

x-aa-authorization

string

required

Bearer

Example:

Bearer aa.oa2.v1.xxx

Responses

🟢200Success

application/json

Body

reports

array [object {22}]

optional

The product report list

marketplace

string

optional

Represents an Amazon marketplace.

date

string

optional

Report Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ

currency

string

optional

Currency code

detailPageViews

integer

optional

Number of product detail page views

addToCarts

integer

optional

Number of product added to the cart

conversions

integer

optional

Number of product purchases

sales

number

optional

Total sales amount after applying all available discounts

directDetailPageViews

integer

optional

Number of direct product detail page views

directAddToCarts

integer

optional

Number of direct product added to the cart

directConversions

integer

optional

Number of direct product purchases

directSales

number

optional

Total direct sales amount

haloDetailPageViews

integer

optional

Number of halo product detail page views

haloAddToCarts

integer

optional

Number of halo product added to the cart

haloConversions

integer

optional

Number of halo product purchases

haloSales

number

optional

Total halo sales amount

commissionEarned

number

optional

Commission amount earned

productId

string

optional

ArtemisAds Identifier for a product.

asin

string

optional

Amazon Standard Identifier for an Amazon product.

productTitle

string

optional

Product title.

productImageUrl

string

optional

Product image URL.

link

object (PublisherProductLink)

optional

Associated link information

finalized

boolean

optional

When true the numbers in this report will not change

cursor

string

optional

The cursor to use for the next request, if empty there are no more items to return

Modified at 2025-06-04 02:32:39

List Product reports