Get click reports at the date/link granularity within a date range.

Method: GET (paginated)

Parameters:

• “limit”
  • Maximum number of reports returned
    • One report entry is one day of reporting for a single link
  • Default value: 25
  • Maximum value: 100
• “cursor”
  • Cursor for pagination
• “start”
  • Start of date range to retrieve reports from (inclusive)
  • Must be specified in ISO format without any offset (UTC)
    • Format: “yyyy-MM-ddTHH:mm:ss.SSSZ”
  • “start” can be a maximum of 1 year before “end”
• “end”
  • End of date range to retrieve reports from (inclusive)
  • Must be specified in ISO format without any offset (UTC)
    • Format: “yyyy-MM-ddTHH:mm:ss.SSSZ”
  • “end” can be a maximum of 1 year after “start”
• “brand_ids”
  • Comma-delimited list of brand IDs to filter results on
  • Optional
• “marketplace”
  • Amazon marketplace to filter by
  • Possible values: “amazon.com”, “amazon.co.uk”, or “all”
  • “amazon.com” is the default value

Response:

{
  "reports": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "string",
      "marketplace": "amazon.com",
      "linkId": "string",
      "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brandId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clicks": 0,
      "final": true
    }
  ],
  "cursor": "string"
}

Errors:

• 400: Bad Request
  • Parameters incorrectly formatted or exceed permitted bounds
• 401: Unauthorized
  • Invalid or omitted API key

Example:

const API_KEY = "LEVANTA_API_KEY"
const ENDPOINT = "<https://app.levanta.io/api/seller/v1/reports/clicks>"

let cursor;
const reports = [];

// Set up query parameters
const parameters = new URLSearchParams();
// Get 50 reports per response
parameters.set("limit", 50);
// Get reports from January 15, 2023 to February 15, 2023
parameters.set("start", "2023-01-15T00:00:00.000Z");
parameters.set("end", "2023-02-15T00:00:00.000Z");

// Paginate through reports, stop when a value of null is returned for "cursor"
while (cursor !== null) {
    const response = await fetch(`${ENDPOINT}?${parameters.toString()}`, {
			method: "GET",
			headers: {
				Authorization: `Bearer ${API_KEY}`
			}
		});
	  const json = await response.json();
		// Store reports returned
	  reports.push(...json.reports);
    cursor = json.cursor;
    if (cursor) parameters.set("cursor", cursor);
}
console.log(reports);