# Profound

> Analyze Profound AI search visibility, citations, sentiment, shopping and bot traffic, and run agents.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/profound

## Actions

### Get agent

Get agent. Returns one response page; the connected account determines access.

**Inputs**

- Agent (`agent_id`, text, required): The ID of the agent to retrieve.
- Version (`version`, text): Version of the agent to retrieve. Use `published` for the live version, or `draft` for the latest unpublished changes for the same agent. Defaults to `published`. One of: `published`, `draft`.

**Outputs**: API response.

- `data` (object): Detailed information for an agent.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "created_at": "2026-01-01T00:00:00Z",
    "description": "example",
    "id": "example",
    "name": "example",
    "organization_id": "example",
    "schema": {
      "input": {},
      "output": {}
    },
    "status": "draft",
    "validation": {
      "issues": [],
      "valid": false
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get agent run

Get agent run. Returns one response page; the connected account determines access.

**Inputs**

- Agent (`agent_id`, text, required): The ID of the agent that owns the run.
- Run ID (`run_id`, text, required): The ID of the run to retrieve.
- Verbose (`verbose`, true/false): Include each step's raw `outputs` payload in the execution trace.

**Outputs**: API response.

- `data` (object): Status and result details for an agent run.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "agent_id": "example",
    "error": {},
    "finished_at": "2026-01-01T00:00:00Z",
    "id": "example",
    "outputs": {},
    "outputs_expanded": {},
    "started_at": "2026-01-01T00:00:00Z",
    "status": "queued",
    "steps": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List agents

List agents. Returns one response page; the connected account determines access.

**Inputs**

- Statuses (`statuses`, list): Optional status filter. Use `published` to list agents that have a live published version, or `draft` to list agents that have not been published yet. Defaults to `published`. One or more of: `published`, `draft`.
- Limit (`limit`, number): Limit. At most 100.
- Next cursor (`next_cursor`, text): Next cursor.

**Outputs**: API response.

- `data` (object): Paginated list of agents.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {
      "limit": 1,
      "next_cursor": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List assets

List assets. Returns one response page; the connected account determines access.

**Inputs**

- Organization IDS (`organization_ids`, list): Restrict results to one or more organizations the caller belongs to. Repeat the parameter to target multiple orgs (e.g. `?organization_ids= &organization_ids= `). Omit to return data from every organization the caller has access to.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List categories

List categories. Returns one response page; the connected account determines access.

**Inputs**

- Organization IDS (`organization_ids`, list): Restrict results to one or more organizations the caller belongs to. Repeat the parameter to target multiple orgs (e.g. `?organization_ids= &organization_ids= `). Omit to return data from every organization the caller has access to.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List category tags

List category tags. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List category topics

List category topics. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List domains

List domains. Returns one response page; the connected account determines access.

**Inputs**

- Organization IDS (`organization_ids`, list): Restrict results to one or more organizations the caller belongs to. Repeat the parameter to target multiple orgs (e.g. `?organization_ids= &organization_ids= `). Omit to return data from every organization the caller has access to.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List models

List models. Returns one response page; the connected account determines access.

**Inputs**: None.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List organizations

List organizations. Returns one response page; the connected account determines access.

**Inputs**: None.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List personas

List personas. Returns one response page; the connected account determines access.

**Inputs**

- Organization IDS (`organization_ids`, list): Restrict results to one or more organizations the caller belongs to. Repeat the parameter to target multiple orgs (e.g. `?organization_ids= &organization_ids= `). Omit to return data from every organization the caller has access to.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List prompts

List prompts. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Limit (`limit`, number): Maximum number of prompts to return. At most 10000.
- Cursor (`cursor`, text): Pagination cursor from a previous response.
- Order by (`order_by`, text): Field used to order prompts. One of: `created_at`, `prompt`.
- Order dir (`order_dir`, text): Sort direction for the selected order field. One of: `asc`, `desc`.
- Analysis type (`analysis_type`, list): Filter by analysis type (visibility, sentiment, accuracy). One or more of: `visibility`, `sentiment`, `sentiment_v2`, `accuracy`.
- Prompt type (`prompt_type`, list): Deprecated. Use analysis_type instead. One or more of: `visibility`, `sentiment`.
- Status (`status`, list): Filter by prompt status. Defaults to `active` only. One or more of: `active`, `disabled`.
- Topic ID (`topic_id`, list): Filter by topic IDs.
- Tag ID (`tag_id`, list): Filter by tag IDs.
- Region ID (`region_id`, list): Filter by region IDs.
- Platform ID (`platform_id`, list): Filter by platform IDs.
- Persona ID (`persona_id`, list): Filter by persona IDs.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "limit": 1,
      "next_cursor": "example",
      "total_rows": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List regions

List regions. Returns one response page; the connected account determines access.

**Inputs**

- Organization IDS (`organization_ids`, list): Restrict results to one or more organizations the caller belongs to. Repeat the parameter to target multiple orgs (e.g. `?organization_ids= &organization_ids= `). Omit to return data from every organization the caller has access to.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Query answers

Query answers. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Include (`include`, list): Which row fields to return: `run_id`, `date`, `model`, `topic`, `topic_id`, `region`, `persona`, `tags`, `prompt`, `prompt_id`, `response`, `mentions`, `citations`, `citation_details`, `search_queries`, `analysis_types`, `sentiment_claims`. Omit for all fields except `citation_details`, which must be requested explicitly because it is expensive. One or more of: `run_id`, `date`, `model`, `topic`, `topic_id`, `persona`, `region`, `tags`, `prompt`, `prompt_id`, and 7 more.
- Filter (`filter`, object): and/or/not tree over `model`, `topic`, `region`, `persona`, `prompt`, `tag`, `analysis_type` (visibility/sentiment/factcheck); plus top-level `and` leaves `domain` or `page` (`is` one value, or `in` a list). Substring-search the prompt with `{"field": "prompt", "op": "contains", "value": "…"}`.
- Limit (`limit`, number): Page size; default 10, max 200. At most 200.
- Max results (`max_results`, number): Stream endpoint only: cap the number of streamed rows (default: all).
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "count": 1,
      "end_date": "example",
      "filter": {},
      "include": [],
      "models": [],
      "next_cursor": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query bots

Query bots. Returns one response page; the connected account determines access.

**Inputs**

- Date interval (`date_interval`, text): Date interval for the report. (only used with date dimension). One of: `hour`, `day`, `week`, `month`, `quarter`, `year`, `relative_week`.
- Dimensions (`dimensions`, list): Dimensions to group the report by. One or more of: `date`, `hour`, `host`, `path`, `bot_name`, `bot_provider`, `bot_type`.
- Metrics (`metrics`, list, required): Metrics. One or more of: `count`, `citations`, `indexing`, `training`, `last_visit`.
- Order by (`order_by`, object): Custom ordering of the report results. The order is a record of key-value pairs where: - key is the field to order by, which can be a metric or dimension - value is the direction of the order, either 'asc' for ascending or 'desc' for descending. When not specified, the default order is the first metric in the query descending.
- Pagination (`pagination`, object): Pagination settings for the report results.
- Domain (`domain`, text, required): Domain to query logs for.
- Start date (`start_date`, date and time, required): Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO timestamp.
- End date (`end_date`, date and time): End date in UTC. Accepts same formats as start_date. Defaults to now UTC if omitted.
- Organization ID (`organization_id`, text): Organization id.
- Timezone (`timezone`, text): IANA timezone name for date bucketing and filter boundaries.
- View ID (`view_id`, text): Domain segment UUID used to scope the query to a configured subset of hosts and paths.
- Metric filters (`metric_filters`, list): Numeric filters applied after report metrics are calculated.
- Filters (`filters`, list): Filters for bots report.
- Domain ID (`domain_id`, text): Domain UUID used for tag lookups.
- Tags (`tags`, list): Tags.

**Outputs**: API response.

- `data` (object): Base response model for reports.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "query": {},
      "total_rows": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query citations

Query citations. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Entity (`entity`, text): What each row represents: `domain` (default), `page`, or `citation_category`. Legacy: `group_by: ["page"]` (with `entity` omitted) is still accepted and is equivalent to `entity: "page"`. `citation_category` uses the dashboard split view: a citation counts under both its page-level and domain-level category, so category shares can sum to more than 100%. One of: `domain`, `page`, `citation_category`.
- Group by (`group_by`, list): Group by. One or more of: `page`, `date`, `model`, `topic`, `region`, `persona`, `prompt`.
- Metrics (`metrics`, list): Metrics. One or more of: `count`, `citation_share`, `rank`, `first_cited_at`.
- Interval (`interval`, text): Interval. One of: `day`, `week`, `month`.
- Scope (`scope`, text): `all` (every cited domain) or `owned` (only your owned domains). Applies to `entity=domain`. One of: `all`, `owned`.
- Filter (`filter`, object): `citation_category` filters on a cited URL's single category; `citation_tag` filters on the custom citation tags a URL carries (a URL can carry several). List the category's tags with `GET /v1/org/categories/{category_id}/citation-tags`.
- Limit (`limit`, number): Page size; default 10, max 50. At most 50.
- Max results (`max_results`, number): Stream endpoint only: cap the number of streamed rows (default: all).
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "analysis_types": [],
      "count": 1,
      "end_date": "example",
      "filter": {},
      "metrics": [],
      "models": [],
      "next_cursor": "example",
      "scope": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query factcheck

Query factcheck. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Group by (`group_by`, list): Up to two dimensions to slice by; empty returns the headline score. `citation` must be alone. One or more of: `date`, `model`, `region`, `persona`, `prompt`, `topic`, `tag`, `citation`, `theme`.
- Filter (`filter`, object): Scope which responses count (see Filtering).
- Limit (`limit`, number): Rows per page; default 100. At most 100.
- Max results (`max_results`, number): Stream only: cap rows returned.
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "count": 1,
      "end_date": "example",
      "filter": {},
      "group_by": [],
      "models": [],
      "next_cursor": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query factcheck claims

Query factcheck claims. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Group by (`group_by`, list): Optional single dim to section the claims (e.g. per model). Empty → one flat claim list. One or more of: `model`, `region`, `persona`, `prompt`, `topic`, `tag`, `theme`.
- Filter (`filter`, object): Scope which responses count (see Filtering).
- Include (`include`, list): Optional per-claim detail fields to add to each claim (see options). One or more of: `theme`, `reasoning`, `models`, `evidence`, `citation_sources`.
- Limit (`limit`, number): Claims (or sections) per page; default 25. At most 100.
- Max results (`max_results`, number): Stream only: cap entries returned.
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "count": 1,
      "end_date": "example",
      "filter": {},
      "group_by": [],
      "include": [],
      "models": [],
      "next_cursor": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query fanouts

Query fanouts. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Group by (`group_by`, list): Group by. One or more of: `date`, `model`, `region`, `prompt`, `query`.
- Metrics (`metrics`, list): Metrics. One or more of: `fanouts_per_execution`, `total_fanouts`, `share`, `query_variations`.
- Interval (`interval`, text): Interval. One of: `day`, `week`, `month`.
- Filter (`filter`, object): A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
- Sort (`sort`, object): Sort.
- Limit (`limit`, number): Page size; default 10, max 50. At most 50.
- Max results (`max_results`, number): Stream endpoint only: cap the number of streamed rows (default: all).
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "count": 1,
      "coverage_note": "example",
      "end_date": "example",
      "filter": {},
      "metrics": [],
      "models": [],
      "next_cursor": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query referrals

Query referrals. Returns one response page; the connected account determines access.

**Inputs**

- Date interval (`date_interval`, text): Date interval for the report. (only used with date dimension). One of: `hour`, `day`, `week`, `month`, `quarter`, `year`, `relative_week`.
- Dimensions (`dimensions`, list): Dimensions to group the report by. One or more of: `date`, `hour`, `host`, `path`, `referral_source`, `referral_type`.
- Metrics (`metrics`, list, required): Metrics. One or more of: `visits`, `last_visit`.
- Order by (`order_by`, object): Custom ordering of the report results. The order is a record of key-value pairs where: - key is the field to order by, which can be a metric or dimension - value is the direction of the order, either 'asc' for ascending or 'desc' for descending. When not specified, the default order is the first metric in the query descending.
- Pagination (`pagination`, object): Pagination settings for the report results.
- Domain (`domain`, text, required): Domain to query logs for.
- Start date (`start_date`, date and time, required): Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO timestamp.
- End date (`end_date`, date and time): End date in UTC. Accepts same formats as start_date. Defaults to now UTC if omitted.
- Organization ID (`organization_id`, text): Organization id.
- Timezone (`timezone`, text): IANA timezone name for date bucketing and filter boundaries.
- View ID (`view_id`, text): Domain segment UUID used to scope the query to a configured subset of hosts and paths.
- Metric filters (`metric_filters`, list): Numeric filters applied after report metrics are calculated.
- Filters (`filters`, list): Filters for referrals report.

**Outputs**: API response.

- `data` (object): Base response model for reports.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "query": {},
      "total_rows": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query sentiment

Query sentiment. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Asset (`asset`, text, required): The brand name to analyze (sentiment is extracted on name, not id).
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Comparison start date (`comparison_start_date`, text): YYYY-MM-DD, ET, inclusive (with end).
- Comparison end date (`comparison_end_date`, text): YYYY-MM-DD, ET, inclusive (with start).
- Source (`source`, text): Source. One of: `response`, `citation`.
- Group by (`group_by`, list): Group by. One or more of: `date`, `model`, `topic`, `region`, `prompt`, `persona`, `tag`, `theme`, `claim`, `run`, `competitor`.
- Metrics (`metrics`, list): Metrics. One or more of: `positive_sentiment`, `negative_sentiment`, `occurrence`, `citation_share`.
- Interval (`interval`, text): Interval. One of: `day`, `week`, `month`.
- Filter (`filter`, object): A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
- Sort (`sort`, object): Sort.
- Include cited websites (`include_cited_websites`, true/false): Return cited websites per row (only when grouping by `theme`/`claim`).
- Limit (`limit`, number): Page size; default 10, max 50. At most 50.
- Max results (`max_results`, number): Stream endpoint only: cap the number of streamed rows (default: all).
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "asset": "example",
      "comparison_end_date": "example",
      "comparison_start_date": "example",
      "count": 1,
      "end_date": "example",
      "filter": {},
      "metrics": [],
      "models": [],
      "next_cursor": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query shopping brands

Query shopping brands. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Group by (`group_by`, list): Group by. One or more of: `date`, `topic`, `region`, `prompt`.
- Metrics (`metrics`, list): Metrics. One or more of: `visibility_score`, `average_position`, `visibility_rank`.
- Interval (`interval`, text): Interval. One of: `day`, `week`, `month`.
- Scope (`scope`, text): Scope. One of: `owned`, `all`.
- Assets (`assets`, text): Restrict to these asset names (a name or list). Overrides `scope`.
- Filter (`filter`, object): A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
- Limit (`limit`, number): Page size for scope=all; default 10, max 50. At most 50.
- Max results (`max_results`, number): Stream endpoint only: cap the number of streamed rows (default: all). At most 50000.
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "assets": "example",
      "count": 1,
      "end_date": "example",
      "filter": {},
      "metrics": [],
      "models": [],
      "next_cursor": "example",
      "scope": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query shopping products

Query shopping products. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Group by (`group_by`, list): Group by. One or more of: `date`, `topic`, `prompt`.
- Metrics (`metrics`, list): Metrics. One or more of: `visibility_score`, `average_position`, `visibility_rank`, `position1_percentage`, `position2_percentage`, `position3_percentage`, `position_above3_percentage`, `product_rating`, `product_num_reviews`.
- Interval (`interval`, text): Interval. One of: `day`, `week`, `month`.
- Include merchants (`include_merchants`, true/false): Include per-product merchant offers (names, prices, urls, images).
- Target product (`target_product`, text): Return this product plus its top competitors (item view only).
- Competitor limit (`competitor_limit`, number): Competitors returned when `target_product` is set. At least 1.
- Filter (`filter`, object): A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
- Limit (`limit`, number): Page size; default 10, max 50. At most 50.
- Max results (`max_results`, number): Stream endpoint only: cap streamed rows. At most 50000.
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "count": 1,
      "end_date": "example",
      "filter": {},
      "include_merchants": false,
      "metrics": [],
      "models": [],
      "next_cursor": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query visibility

Query visibility. Returns one response page; the connected account determines access.

**Inputs**

- Category (`category_id`, text, required): Category id.
- Start date (`start_date`, date, required): YYYY-MM-DD, ET, inclusive
- End date (`end_date`, date, required): YYYY-MM-DD, ET, inclusive
- Group by (`group_by`, list): Group by. One or more of: `date`, `model`, `topic`, `region`, `prompt`, `persona`.
- Metrics (`metrics`, list): Metrics. One or more of: `visibility_score`, `share_of_voice`, `average_position`.
- Interval (`interval`, text): Interval. One of: `day`, `week`, `month`.
- Scope (`scope`, text): Scope. One of: `owned`, `all`.
- Assets (`assets`, text): A name (`is`), a list (`in`), or {op,value} with op `is`/`in`/`not_in`.
- Filter (`filter`, object): A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
- Sort (`sort`, object): Sort.
- Limit (`limit`, number): Page size; default 10, max 50. At most 50.
- Max results (`max_results`, number): Stream endpoint only: cap the number of streamed rows (default: all).
- Cursor (`cursor`, text): Cursor.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": [],
    "info": {
      "asset_filter": {},
      "count": 1,
      "end_date": "example",
      "filter": {},
      "models": [],
      "next_cursor": "example",
      "scope": "example",
      "start_date": "example",
      "total_results": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Run agent

Run agent. Returns one response page; the connected account determines access.

**Inputs**

- Agent (`agent_id`, text, required): The ID of the agent to run.
- Inputs (`inputs`, object): Input values for the run. Keys should match the property names defined in `schema.input`. Omit the request body when the agent does not require inputs.

**Outputs**: API response.

- `data` (object): Run details returned after a run request is accepted.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "agent_id": "example",
    "id": "example",
    "started_at": "2026-01-01T00:00:00Z",
    "status": "queued"
  },
  "has_more": false,
  "next_cursor": null
}
```
