List Reports - OpenLight API

List creator report rows

curl --request GET \
  --url https://app.openlight.tech/api/creator/v1/reports \
  --header 'Authorization: Bearer <token>'

{
  "reports": [
    {
      "date": "2023-12-25",
      "brand_id": "<string>",
      "product_id": "<string>",
      "asin": "<string>",
      "marketplace": "<string>",
      "currency": "<string>",
      "sales_cents": 123,
      "commission_cents": 123,
      "commission_status": "<string>",
      "orders": 123,
      "units_sold": 123,
      "clicks": 123,
      "detail_page_views": 123,
      "add_to_carts": 123,
      "link": {
        "id": "<string>",
        "tracking_id": "<string>",
        "short_url": "<string>",
        "destination_url": "<string>"
      }
    }
  ],
  "next_cursor": "<string>"
}

GET

api

creator

reports

List creator report rows

curl --request GET \
  --url https://app.openlight.tech/api/creator/v1/reports \
  --header 'Authorization: Bearer <token>'

{
  "reports": [
    {
      "date": "2023-12-25",
      "brand_id": "<string>",
      "product_id": "<string>",
      "asin": "<string>",
      "marketplace": "<string>",
      "currency": "<string>",
      "sales_cents": 123,
      "commission_cents": 123,
      "commission_status": "<string>",
      "orders": 123,
      "units_sold": 123,
      "clicks": 123,
      "detail_page_views": 123,
      "add_to_carts": 123,
      "link": {
        "id": "<string>",
        "tracking_id": "<string>",
        "short_url": "<string>",
        "destination_url": "<string>"
      }
    }
  ],
  "next_cursor": "<string>"
}

Use this endpoint to query report rows visible to the current creator token owner. Rows are grouped by date, product, attribution link, and Amazon marketplace so integrations can show link performance and reconcile orders and commissions. Pass both start and end in YYYY-MM-DD format. Optional filters include brand_id, product_id, asin, link_id, and marketplace; marketplace is an Amazon country or region code such as US, UK, or DE. Pagination uses limit and cursor: limit defaults to 100 and maxes out at 500; when next_cursor is not null, pass it as cursor on the next request. Response fields:

date: Report date.
brand_id: Brand ID.
product_id: Product ID.
asin: Amazon ASIN.
marketplace: Amazon country or region code, such as US, UK, or DE.
currency: Currency for sales and commission amounts.
sales_cents: Sales amount in minor currency units.
commission_cents: Commission amount in minor currency units.
commission_status: Commission settlement status.
orders: Number of orders.
units_sold: Number of units sold.
clicks: Number of clicks.
detail_page_views: Number of detail page views.
add_to_carts: Number of add-to-cart events.
link.id: Attribution link ID.
link.tracking_id: Client-side tracking tag supplied at link creation; empty string when omitted.
link.short_url: Shareable attribution short URL.
link.destination_url: Amazon landing page URL for the attribution link.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start

string<date>

required

开始日期，格式为 YYYY-MM-DD。Start date in YYYY-MM-DD format.

end

string<date>

required

结束日期，格式为 YYYY-MM-DD。End date in YYYY-MM-DD format.

limit

integer

default:100

每页返回报表行数，默认 100，最大 500。Number of report rows per page; defaults to 100 and maxes out at 500.

Required range: 1 <= x <= 500

cursor

string

上一页响应返回的下一页游标。Cursor returned as next_cursor by the previous page.

brand_id

string

按品牌 ID 筛选。Filter by brand ID.

product_id

string

按商品 ID 筛选。Filter by product ID.

asin

string

按 Amazon ASIN 筛选。Filter by Amazon ASIN.

link_id

string

按归因链接 ID 筛选。Filter by attribution link ID.

marketplace

string

按 Amazon 国家/地区码筛选，例如 US、UK、DE。Filter by Amazon marketplace country or region code, such as US, UK, or DE.

Response

Creator report rows

reports

object[]

required

报表行列表。List of report rows.

Show child attributes

next_cursor

string | null

required

下一页游标；为 null 表示没有更多结果。Cursor for the next page; null means there are no more results.

Create attribution link