Profound

App · 25 actions

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

Actions

ActionWhat it does
Get agentGet agent.
Get agent runGet agent run.
List agentsList agents.
List assetsList assets.
List categoriesList categories.
List category tagsList category tags.
List category topicsList category topics.
List domainsList domains.
List modelsList models.
List organizationsList organizations.
List personasList personas.
List promptsList prompts.
List regionsList regions.
Query answersQuery answers.
Query botsQuery bots.
Query citationsQuery citations.
Query factcheckQuery factcheck.
Query factcheck claimsQuery factcheck claims.
Query fanoutsQuery fanouts.
Query referralsQuery referrals.
Query sentimentQuery sentiment.
Query shopping brandsQuery shopping brands.
Query shopping productsQuery shopping products.
Query visibilityQuery visibility.
Run agentRun agent.

Get agent

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

Inputs

Agentagent_idtextRequired
The ID of the agent to retrieve.
Versionversiontext
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.

dataobject
Detailed information for an agent.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Agentagent_idtextRequired
The ID of the agent that owns the run.
Run IDrun_idtextRequired
The ID of the run to retrieve.
Verboseverbosetrue/false
Include each step's raw `outputs` payload in the execution trace.

Outputs

API response.

dataobject
Status and result details for an agent run.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Statusesstatuseslist
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.
Limitlimitnumber
Limit.At most 100.
Next cursornext_cursortext
Next cursor.

Outputs

API response.

dataobject
Paginated list of agents.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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 IDSorganization_idslist
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.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List categories

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

Inputs

Organization IDSorganization_idslist
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.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List category tags

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

Inputs

Categorycategory_idtextRequired
Category id.

Outputs

API response.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List category topics

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

Inputs

Categorycategory_idtextRequired
Category id.

Outputs

API response.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List domains

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

Inputs

Organization IDSorganization_idslist
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.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List personas

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

Inputs

Organization IDSorganization_idslist
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.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List prompts

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

Inputs

Categorycategory_idtextRequired
Category id.
Limitlimitnumber
Maximum number of prompts to return.At most 10000.
Cursorcursortext
Pagination cursor from a previous response.
Order byorder_bytext
Field used to order prompts.One of: created_at, prompt.
Order dirorder_dirtext
Sort direction for the selected order field.One of: asc, desc.
Analysis typeanalysis_typelist
Filter by analysis type (visibility, sentiment, accuracy).One or more of: visibility, sentiment, sentiment_v2, accuracy.
Prompt typeprompt_typelist
Deprecated. Use analysis_type instead.One or more of: visibility, sentiment.
Statusstatuslist
Filter by prompt status. Defaults to `active` only.One or more of: active, disabled.
Topic IDtopic_idlist
Filter by topic IDs.
Tag IDtag_idlist
Filter by tag IDs.
Region IDregion_idlist
Filter by region IDs.
Platform IDplatform_idlist
Filter by platform IDs.
Persona IDpersona_idlist
Filter by persona IDs.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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 IDSorganization_idslist
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.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Query answers

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

Inputs

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Includeincludelist
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.
Filterfilterobject
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": "…"}`.
Limitlimitnumber
Page size; default 10, max 200.At most 200.
Max resultsmax_resultsnumber
Stream endpoint only: cap the number of streamed rows (default: all).
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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 intervaldate_intervaltext
Date interval for the report. (only used with date dimension)One of: hour, day, week, month, quarter, year, relative_week.
Dimensionsdimensionslist
Dimensions to group the report by.One or more of: date, hour, host, path, bot_name, bot_provider, bot_type.
MetricsmetricslistRequired
Metrics.One or more of: count, citations, indexing, training, last_visit.
Order byorder_byobject
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.
Paginationpaginationobject
Pagination settings for the report results.
DomaindomaintextRequired
Domain to query logs for.
Start datestart_datedate and timeRequired
Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO timestamp.
End dateend_datedate and time
End date in UTC. Accepts same formats as start_date. Defaults to now UTC if omitted.
Organization IDorganization_idtext
Organization id.
Timezonetimezonetext
IANA timezone name for date bucketing and filter boundaries.
View IDview_idtext
Domain segment UUID used to scope the query to a configured subset of hosts and paths.
Metric filtersmetric_filterslist
Numeric filters applied after report metrics are calculated.
Filtersfilterslist
Filters for bots report.
Domain IDdomain_idtext
Domain UUID used for tag lookups.
Tagstagslist
Tags.

Outputs

API response.

dataobject
Base response model for reports.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Entityentitytext
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 bygroup_bylist
Group by.One or more of: page, date, model, topic, region, persona, prompt.
Metricsmetricslist
Metrics.One or more of: count, citation_share, rank, first_cited_at.
Intervalintervaltext
Interval.One of: day, week, month.
Scopescopetext
`all` (every cited domain) or `owned` (only your owned domains). Applies to `entity=domain`.One of: all, owned.
Filterfilterobject
`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`.
Limitlimitnumber
Page size; default 10, max 50.At most 50.
Max resultsmax_resultsnumber
Stream endpoint only: cap the number of streamed rows (default: all).
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Group bygroup_bylist
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.
Filterfilterobject
Scope which responses count (see Filtering).
Limitlimitnumber
Rows per page; default 100.At most 100.
Max resultsmax_resultsnumber
Stream only: cap rows returned.
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Group bygroup_bylist
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.
Filterfilterobject
Scope which responses count (see Filtering).
Includeincludelist
Optional per-claim detail fields to add to each claim (see options).One or more of: theme, reasoning, models, evidence, citation_sources.
Limitlimitnumber
Claims (or sections) per page; default 25.At most 100.
Max resultsmax_resultsnumber
Stream only: cap entries returned.
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Group bygroup_bylist
Group by.One or more of: date, model, region, prompt, query.
Metricsmetricslist
Metrics.One or more of: fanouts_per_execution, total_fanouts, share, query_variations.
Intervalintervaltext
Interval.One of: day, week, month.
Filterfilterobject
A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
Sortsortobject
Sort.
Limitlimitnumber
Page size; default 10, max 50.At most 50.
Max resultsmax_resultsnumber
Stream endpoint only: cap the number of streamed rows (default: all).
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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 intervaldate_intervaltext
Date interval for the report. (only used with date dimension)One of: hour, day, week, month, quarter, year, relative_week.
Dimensionsdimensionslist
Dimensions to group the report by.One or more of: date, hour, host, path, referral_source, referral_type.
MetricsmetricslistRequired
Metrics.One or more of: visits, last_visit.
Order byorder_byobject
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.
Paginationpaginationobject
Pagination settings for the report results.
DomaindomaintextRequired
Domain to query logs for.
Start datestart_datedate and timeRequired
Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO timestamp.
End dateend_datedate and time
End date in UTC. Accepts same formats as start_date. Defaults to now UTC if omitted.
Organization IDorganization_idtext
Organization id.
Timezonetimezonetext
IANA timezone name for date bucketing and filter boundaries.
View IDview_idtext
Domain segment UUID used to scope the query to a configured subset of hosts and paths.
Metric filtersmetric_filterslist
Numeric filters applied after report metrics are calculated.
Filtersfilterslist
Filters for referrals report.

Outputs

API response.

dataobject
Base response model for reports.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
AssetassettextRequired
The brand name to analyze (sentiment is extracted on name, not id).
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Comparison start datecomparison_start_datetext
YYYY-MM-DD, ET, inclusive (with end).
Comparison end datecomparison_end_datetext
YYYY-MM-DD, ET, inclusive (with start).
Sourcesourcetext
Source.One of: response, citation.
Group bygroup_bylist
Group by.One or more of: date, model, topic, region, prompt, persona, tag, theme, claim, run, competitor.
Metricsmetricslist
Metrics.One or more of: positive_sentiment, negative_sentiment, occurrence, citation_share.
Intervalintervaltext
Interval.One of: day, week, month.
Filterfilterobject
A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
Sortsortobject
Sort.
Include cited websitesinclude_cited_websitestrue/false
Return cited websites per row (only when grouping by `theme`/`claim`).
Limitlimitnumber
Page size; default 10, max 50.At most 50.
Max resultsmax_resultsnumber
Stream endpoint only: cap the number of streamed rows (default: all).
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Group bygroup_bylist
Group by.One or more of: date, topic, region, prompt.
Metricsmetricslist
Metrics.One or more of: visibility_score, average_position, visibility_rank.
Intervalintervaltext
Interval.One of: day, week, month.
Scopescopetext
Scope.One of: owned, all.
Assetsassetstext
Restrict to these asset names (a name or list). Overrides `scope`.
Filterfilterobject
A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
Limitlimitnumber
Page size for scope=all; default 10, max 50.At most 50.
Max resultsmax_resultsnumber
Stream endpoint only: cap the number of streamed rows (default: all).At most 50000.
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Group bygroup_bylist
Group by.One or more of: date, topic, prompt.
Metricsmetricslist
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.
Intervalintervaltext
Interval.One of: day, week, month.
Include merchantsinclude_merchantstrue/false
Include per-product merchant offers (names, prices, urls, images).
Target producttarget_producttext
Return this product plus its top competitors (item view only).
Competitor limitcompetitor_limitnumber
Competitors returned when `target_product` is set.At least 1.
Filterfilterobject
A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
Limitlimitnumber
Page size; default 10, max 50.At most 50.
Max resultsmax_resultsnumber
Stream endpoint only: cap streamed rows.At most 50000.
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Categorycategory_idtextRequired
Category id.
Start datestart_datedateRequired
YYYY-MM-DD, ET, inclusive
End dateend_datedateRequired
YYYY-MM-DD, ET, inclusive
Group bygroup_bylist
Group by.One or more of: date, model, topic, region, prompt, persona.
Metricsmetricslist
Metrics.One or more of: visibility_score, share_of_voice, average_position.
Intervalintervaltext
Interval.One of: day, week, month.
Scopescopetext
Scope.One of: owned, all.
Assetsassetstext
A name (`is`), a list (`in`), or {op,value} with op `is`/`in`/`not_in`.
Filterfilterobject
A leaf (`field`/`op`/`value`) or an `and`/`or`/`not` group.
Sortsortobject
Sort.
Limitlimitnumber
Page size; default 10, max 50.At most 50.
Max resultsmax_resultsnumber
Stream endpoint only: cap the number of streamed rows (default: all).
Cursorcursortext
Cursor.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "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

Agentagent_idtextRequired
The ID of the agent to run.
Inputsinputsobject
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.

dataobject
Run details returned after a run request is accepted.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": {
    "agent_id": "example",
    "id": "example",
    "started_at": "2026-01-01T00:00:00Z",
    "status": "queued"
  },
  "has_more": false,
  "next_cursor": null
}

On this page