Get click reports at the day/link granularity within a date range [start, end]

Method: GET (paginated)

Parameters:

• “limit”
  • Maximum number of reports returned
    • One report is one day of reporting for a single ASIN/source
  • Default value: 100
  • Maximum value: 250
• “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 apart from “start”
• “link_ids”
  • Comma-delimited list of link IDs to filter results on
  • IDs for links can be obtained via the /links endpoint
  • Optional
• “source_id”
  • Source ID to filter results on
  • A source ID is used to distinguish where a link is to be used and is associated to a link when that link is created
    • Examples: “default”, “instagram”, “blog”, etc.
  • Optional
• “source_sub_id”
  • Source Sub ID to filter results on
  • Optional
• “marketplace”
  • Marketplace filter

Response:

{
  "reports": [
    {
      "date": "string",
      "marketplace": "amazon.com",
      "clicks": 0,
      "link": {
        "id": "string",
        "sourceId": "string",
        "sourceSubId": "string",
        "sourceName": "string",
        "url": "string",
        "active": true,
        "type": "product",
        "marketplace": "amazon.com"
      },
      "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/creator/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);