Skip to main content

Documentation Index

Fetch the complete documentation index at: https://usesapient.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Actions are prompt-level work items Sapient derives from Visibility data. Use them to inspect cited pages and opportunities found from existing prompt results. The response contains two sections:
  • opportunities: content, competitor, sentiment, visibility, and citation opportunities.
  • cited_pages: pages cited in AI answers, with citation counts and page metadata.

Command

CommandDescription
sapient prompts actions listList prompt actionables.

List actionables

List both sections:
sapient prompts actions list --tag all --limit 25
Return only opportunities:
sapient prompts actions list \
  --tag opportunities \
  --category quick_wins \
  --opportunity-type citation_gaps
Return only cited pages:
sapient prompts actions list \
  --tag cited_pages \
  --prompt-ids prompt_123,prompt_456 \
  --cited-pages-limit 50
Filter by date window:
sapient prompts actions list \
  --start-date 2026-05-01 \
  --end-date 2026-05-23
Example response:
{
  "start_date": "2026-05-01",
  "end_date": "2026-05-23",
  "tag": "all",
  "opportunities": [
    {
      "id": "opp_123",
      "type": "citation_gaps",
      "category": "citations",
      "priority": "high",
      "title": "Improve citations for API authentication docs",
      "description": "Competitor docs are cited more often for authentication prompts.",
      "action": "Add clearer authentication examples and troubleshooting guidance.",
      "impact_score": 87.5,
      "created_at": "2026-05-23T00:00:00Z"
    }
  ],
  "opportunity_count": 1,
  "cited_pages": [
    {
      "url": "https://docs.example.com/authentication",
      "domain": "docs.example.com",
      "title": "Authentication",
      "is_company_link": true,
      "citation_count": 14
    }
  ],
  "cited_page_count": 1,
  "summary": {
    "by_category": {
      "citations": 1
    }
  }
}
Useful filters:
FlagDescription
--tagReturn cited_pages, opportunities, or all. Defaults to all.
--sinceRelative lookback window such as 7d or 72h.
--start-dateInclusive start date.
--end-dateInclusive end date.
--categoryOpportunity category, such as quick_wins, growth, refresh, or citations.
--opportunity-typeOpportunity type, such as citation_gaps or competitor_gaps.
--topic-idRestrict results to one topic.
--prompt-idsComma-separated prompt IDs.
--include-cited-pagesInclude cited page details when --tag all is used.
--limitMaximum opportunities to return.
--cited-pages-limitMaximum cited pages to return.