List campaigns
list_campaignsLists ad campaigns with profit ranges, spend, retention, payback, and SCALE/CUT/HOLD recommendations to compare performance over a chosen date window.
Instructions
List ad campaigns with their honest profit surface. call preserves the original v1 fail-closed automation behavior for multi-component rows; recommended_call is the additive SCALE/CUT/HOLD recommendation the current engine made. It is backed by envelope_lower/envelope_central/envelope_upper. Read aggregation_basis before quoting the low end: single_component_quantiles means it is a calibrated 5th percentile; marginal_endpoint_sum_no_joint_coverage means it is the sum of each component period's own low end, which is pessimistic against independence but is NOT a floor or a guarantee, so describe it as a scenario. The quantile-named profit_p05/profit_p50/profit_p95 are null unless one component supplied calibrated ones. Also includes spend, retention, and payback.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last UTC day of an explicit window, YYYY-MM-DD, inclusive. Use instead of period; sending both is a 400. | |
| from | No | First UTC day of an explicit window, YYYY-MM-DD, inclusive. Use instead of period; sending both is a 400. | |
| limit | No | Rows per page, 1-200. The API defaults to 50, so a workspace with more than that needs paging. | |
| app_id | No | Optional app id to scope the result to one app. | |
| cursor | No | Pass the next_cursor from the previous response to fetch the following page. Omit for the first page. | |
| period | No | Reporting window. Omit to use the endpoint's documented default. |