FeminiInstall

Summary

Retrieve administrative metrics from Femini within a specified date range, filtered optionally by client, partner, campaign, and click URL IDs, to obtain detailed report data including spends, information, and change logs.

Inputs

• Start Date (YYYY-MM-DD) — Start date to filter the admin information query, formatted as YYYY-MM-DD. Defaults to the first day of the previous month.
• End Date (YYYY-MM-DD) — End date to filter the admin information query, formatted as YYYY-MM-DD. Defaults to yesterday.
• Admin Metrics — Comma-separated list of administrative metrics to retrieve. Options include direct_spends, infomation, direct_spend_with_change_logs, infomation_with_change_logs, price_rate_change_logs, spend_requests, spend_request_with_change_logs. Defaults to 'infomation'.
• Client IDs (Optional) — Comma-separated client IDs to filter the results. Leave empty to query all clients.
• Partner IDs (Optional) — Comma-separated partner IDs to filter the results. Leave empty to query all partners.
• Campaign IDs (Optional) — Comma-separated campaign IDs to filter the results. Leave empty to query all campaigns.
• Click URL IDs (Optional) — Comma-separated click URL IDs to filter the results. Leave empty to query all click URLs.

Output shape

a single JSON object containing the admin information metrics matching the filters

The output JSON structure depends on the selected metrics and filters. The query uses pagination implicitly by the API but this operation returns all data fetched in one response. Errors occur if the underlying API request fails.

Examples

Example 1: Retrieve 'infomation' and 'direct_spends' metrics for clients 123 and 456 between 2025-04-01 and 2025-04-30

Set 'Start Date' to '2025-04-01', 'End Date' to '2025-04-30', 'Admin Metrics' to 'infomation,direct_spends', and 'Client IDs' to '123,456'.