reports

GET /v1/reports/search

Search existing reports by title and content: report titles and block headings/titles (text blocks, and chart, table, big-number, and map block titles); body text is not searched. Multiple words are matched independently. Returns the most recently updated matching reports, each flagged by whether it matched on the title or on content. Prefer this first for broad or open-ended questions about how an area, topic, or the business is doing, such as 'how is retention trending?', 'what's the latest on churn?', or 'give me a read on sales this quarter'. Teams curate reports as the canonical, vetted answer to exactly these questions, so look for an existing report before assembling answers from individual metrics. Skip it for precise, computational asks that name a specific metric, value, breakdown, or chart, such as 'what was MRR last month?' or 'chart gross margin by month'; use the metric tools directly for those.

Request

  • Base URL
    https://help.steep.app (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

qstring required

Search query of up to 5 words. Each word is matched independently: a report matches if any word appears in its title or content.

limitinteger

Maximum number of hits to return.

Response

Response for status 200

Changes

No recorded changes to this operation across all 1 revision of this API.