KayzenInstall

Summary

List reports from the Kayzen API with optional filtering by advertiser ID, search query, and customizable pagination and sorting.

Inputs

• Advertiser ID — Filter reports by a specific advertiser ID (number). Use 0 or omit to not filter by advertiser.
• Search Query — Filter reports by name or ID containing this string (case-insensitive).
• Page — Page number of the results to retrieve, minimum value is 1. Defaults to 1.
• Per Page — Number of reports per page in the response, between 1 and 100. Defaults to 30.
• Sort Field — Field to sort the report results by. Options include id, advertiser_id, name, report_type, time_range, report_schedule_frequency, report_schedule_status, report_schedule_last_sent. Defaults to 'id'.
• Sort Direction — Sort direction for the results, either ascending ('asc') or descending ('desc'). Defaults to ascending.

Output shape

A JSON object containing a list of report records as returned from the Kayzen reports endpoint, limited and filtered by the specified parameters.

The response includes pagination and filtering applied via the input parameters. If no filters are set, the operation returns the default first page of reports sorted by id ascending. The output JSON structure directly reflects the Kayzen reports API response under a 'json' key.

Examples

Example 1: List first 30 reports for advertiser ID 123, sorted by name descending.

Set Advertiser ID=123, Page=1, Per Page=30, Sort Field='name', Sort Direction='desc'.

Example 2: Search all reports with name or ID containing 'campaign' on page 2 with 50 reports per page, sorted by report_schedule_last_sent ascending.

Set Search Query='campaign', Page=2, Per Page=50, Sort Field='report_schedule_last_sent', Sort Direction='asc'.