Actions31
- Action Actions
- Brand Actions
- Chat Actions
- Domain Actions
- Model Actions
- Project Actions
- Prompt Actions
- Search Query Actions
- Shopping Query Actions
- Tag Actions
- Topic Actions
- URL Actions
Brand → Get Report
AI-generatedSummary
Fetches brand-visibility metrics aggregated over a date range from the Peec AI platform.
Inputs
- projectId (required) — Identifier for the Peec project to query.
- startDate (required) — Inclusive start date of the date range (format: YYYY-MM-DD).
- endDate (required) — Inclusive end date of the date range (format: YYYY-MM-DD).
- model_channel_id — Filter results by a specific AI engine channel (e.g., openai-0, anthropic-0).
- brand_ids — Comma-separated list of brand IDs (kw_...) to include in the report.
- limit — Maximum number of results to return. Default is 50, max is 10,000.
- offset — Number of results to skip (for pagination). Default is 0.
Output shape
A list of items, each representing a data row from the report containing aggregated brand-visibility metrics.
The exact fields in the data rows are determined by the Peec AI backend and may vary; pagination is supported via Limit and Offset.
Examples
Example 1: Get a summary report for your own brand over the last 30 days.
Set Project ID, Start Date (e.g., 2023-01-01), and End Date (e.g., 2023-01-31).
Example 2: Filter the report to show metrics only for OpenAI models.
Select Project ID, date range, and set Model Channel to 'OpenAI 0 (ChatGPT Scraper)'.