List Product reports

GET

/openapi/publisher/v1/reports

Retrieve aggregated product reports grouped by dimensions such as PERFORMANCE, PRODUCT, or BRAND. The aggregation is determined by the reportType parameter. he 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?reportType=PERFORMANCE&marketplace=amazon.com&start=2025-01-01T08:00:00.000Z&end=2025-05-31T08:00:00.000Z&asin=B0DGXXWGNQ&productId=aa_86Rf07xd4ztfA13R&brandId=aa_J9HAfx0jN2TjHqzv&limit=100&cursor=86Rf07xd4ztfA2ztfA' \
--header 'x-aa-authorization: Bearer aa.oa2.v1.xxx'

Response Example

{
    "reports": [
        {
            "detailPageViews": 0,
            "addToCarts": 0,
            "conversions": 0,
            "sales": 0,
            "directDetailPageViews": 0,
            "directAddToCarts": 0,
            "directConversions": 0,
            "directSales": 0,
            "haloDetailPageViews": 0,
            "haloAddToCarts": 0,
            "haloConversions": 0,
            "haloSales": 0,
            "commissionEarned": 0,
            "date": "string",
            "clicks": 0,
            "productId": "string",
            "asin": "string",
            "productTitle": "string",
            "productImageUrl": "string",
            "links": {
                "linkId": "string",
                "productId": "string",
                "asin": "string",
                "sourceId": "string",
                "sourceName": "string",
                "marketplace": "string",
                "productStatus": "string",
                "trackingLink": "string",
                "shortTrackingLink": "string"
            },
            "brandId": "string",
            "brandName": "string",
            "brandLogoImageUrl": "string",
            "brandBiography": "string"
        }
    ],
    "cursor": "string"
}

Request

Query Params

reportType

enum<string>

required

The type of report. Available options:PERFORMANCE, PRODUCT, BRAND.

Allowed values:

PERFORMANCEPRODUCTBRAND

Example:

PERFORMANCE

marketplace

string

optional

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

Example:

amazon.com

start

string

optional

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

Example:

2025-01-01T08:00:00.000Z

end

string

optional

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

Example:

2025-05-31T08:00:00.000Z

asin

string

optional

ASIN

Example:

B0DGXXWGNQ

productId

string

optional

ArtemisAds Product Identifier.

Example:

aa_86Rf07xd4ztfA13R

brandId

string

optional

ArtemisAds Brand Identifier.

Example:

aa_J9HAfx0jN2TjHqzv

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

required

Bearer

Default:

Bearer aa.oa2.v1.xxx

Example:

Bearer aa.oa2.v1.xxx

Responses

🟢200OK

application/json

Body

reports

array [object {24}]

required

The product report list

detailPageViews

integer

required

Number of times the product detail page was viewed

addToCarts

integer

required

Number of times the product was added to the cart

conversions

integer

required

Number of product purchases

sales

number

required

Total sales amount after all applicable discounts

directDetailPageViews

integer

required

Number of direct product detail page views.

directAddToCarts

integer

required

Number of direct product added to the cart.

directConversions

integer

required

Number of direct product purchases.

directSales

number

required

Total direct sales amount.

haloDetailPageViews

integer

required

Number of halo product detail page views.

haloAddToCarts

integer

required

Number of halo product added to the cart.

haloConversions

integer

required

Number of halo product purchases.

haloSales

number

required

Total halo sales amount.

commissionEarned

number

required

Commission amount earned

date

string | null

optional

Report Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ. Applies only to PERFORMANCE reportType.

clicks

integer | null

optional

Number of link clicks. Applies only to PERFORMANCE reportType.

productId

string | null

optional

ArtemisAds Identifier for a product. Applies only to PRODUCT reportType.

asin

string | null

optional

Amazon Standard Identifier for an Amazon product. Applies only to PRODUCT reportType.

productTitle

string | null

optional

Product title. Applies only to PRODUCT reportType.

productImageUrl

string | null

optional

Product image URL. Applies only to PRODUCT reportType.

links

object | null

optional

Associated link information. Applies only to PRODUCT reportType.

brandId

string | null

optional

ArtemisAds Brand Identifier. Applies only to BRAND reportType.

brandName

string | null

optional

Brand name. Applies only to BRAND reportType.

brandLogoImageUrl

string | null

optional

Brand logo image URL. Applies only to BRAND reportType.

brandBiography

string | null

optional

Brand description. Applies only to BRAND reportType.

cursor

string | null

optional

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

Modified at 2025-06-04 02:31:08

List Brand Storefront Links

List Per-Product reports