Skip to main content

DocsREST API and MCP server

Results API

Endpoints, auth and live samples for Audience Builder, Connect Data and CRM sync.

Base URLhttps://us-farmvision-new-api.onrender.com

Connect Data: Results

Get Run

One run with its column snapshot and result flags: hasEnrich (an enrichment job completed), hasAiMatch (AI analysis results exist) and hasDataMatch. 404 if the run is not yours or does not exist.

GEThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/runs/:runIdTry it

In this section

Authentication

Get API key

Bearer token

Send your GTM Scoop API key (llmcp_…) or a signed-in session token as a Bearer token.

Authorization: Bearer YOUR_API_KEY

Path parameters

FieldTypeDescription
runIdpathrequiredstringThe run's id (a UUID).

Mounted at

/api/v1/lead-generation

Read what a run produced: the enrichment grid, AI analysis prospects, single records, counts, a breakdown dashboard, and your like/dislike verdicts on rows. AI and enrichment detail fields above your current plan's tier are left out of results, records and the dashboard.

Try it in the playground

Signed out: 10 free tries a day with names hidden. Log in for live data.

Open playground

Related endpoints

All 9 endpoints in this section

Bearer token: an llmcp_ API key or a signed-in session token.

MethodPathWhat it does
GET/api/v1/lead-generation/runs/:runId

Get Run

One run with its column snapshot and result flags: hasEnrich (an enrichment job completed), hasAiMatch (AI analysis results exist) and hasDataMatch. 404 if the run is not yours or does not exist.

1 parameter
  • runId (string, required) The run's id (a UUID).
Try Get Run in the Playground
GET/api/v1/lead-generation/runs/:runId/results

Get Run Results

The full result grid for one pass of a run, every row in a single response (no paging). Omit mode to get the best available pass: AI, then Data, then enrichment. 404 ("This run has no results yet") until that pass has finished.

2 parameters
  • runId (string, required) The run's id (a UUID).
  • mode (string) enrich: business/farm enrichment of your own rows (matchMode null; source is your row keyed by column id, enriched holds the matched fields by label). enrich_property: property enrichment, same shape. ai: AI analysis prospects ordered by GTM Score (matchMode "ai"; source is empty, enriched uses biz_* field ids; adds businessRecordIds, farmRecordIds, opportunities and briefs). data: legacy Data-match results, which current runs do not produce.
Try Get Run Results in the Playground
GET/api/v1/lead-generation/runs/:runId/results/counts

Get Run Result Counts

Just totalRows and matchedCount for one pass, without the rows: fast enough for stat cards while the full grid loads. mode is required (400 without it). 404 when that pass has no results yet; farm-only and property enrichment have no fast count, so read Get Run Results for those.

2 parameters
  • runId (string, required) The run's id (a UUID).
  • mode (string, required) "ai", "data" or "enrich". For ai, totalRows and matchedCount are both the number of delivered prospects.
Try Get Run Result Counts in the Playground
GET/api/v1/lead-generation/runs/:runId/records/:rowIndex

Get Run Record

One row of a run's AI analysis results with the column definitions needed to render it: the single-prospect view. rowIndex is the row's position in the results grid (AI rows are ordered by GTM Score). Enrichment rows are not served here; read them from Get Run Results.

3 parameters
  • runId (string, required) The run's id (a UUID).
  • rowIndex (integer, required) 0-based row position, 0 or more (400 otherwise). 404 past the last row.
  • mode (string) "ai" (or the legacy "data"). Always send it; without it the server probes each pass in turn.
Try Get Run Record in the Playground
GET/api/v1/lead-generation/runs/:runId/business-analytics

Get Run Dashboard

Aggregated breakdowns of a run's results (geography, industry, size, contactability, data quality, farm attributes and per-column coverage), computed from the same rows the grid shows. segment narrows it to rows you liked or disliked through Record Run Feedback. 404 when the run has no results for that pass.

3 parameters
  • runId (string, required) The run's id (a UUID).
  • mode (string) "ai", "data", "enrich" or "enrich_property"; omitted, the best available pass. Send it whenever you use segment, so verdicts are read for the same pass.
  • segment (string) "all" (default), "liked" or "disliked". Anything else is a 400.
Try Get Run Dashboard in the Playground
GET/api/v1/lead-generation/runs/:runId/match-summary

Get Match Summary

How many AI analysis and Data-match prospects a run has; count is null for a pass with no results, and an unknown run returns nulls rather than a 404. savedList is filled only for lists saved by older versions; find a run's current lists with List Saved Lists (each carries runId).

1 parameter
  • runId (string, required) The run's id (a UUID).
Try Get Match Summary in the Playground
GET/api/v1/lead-generation/runs/:runId/feedback

List Run Feedback

Your like/dislike verdicts on a run's result rows, ordered by row. Omit mode for every pass, send mode=ai or mode=data for one pass, or an empty mode= for the enrichment pass; any other value is a 400.

2 parameters
  • runId (string, required) The run's id (a UUID).
  • mode (string) "ai", "data", or empty for the enrichment pass. Omitted: verdicts from every pass.
Try List Run Feedback in the Playground
POST/api/v1/lead-generation/runs/:runId/feedback

Record Run Feedback

Marks one result row as liked or disliked; voting again on the same row and pass replaces the earlier verdict and keeps its createdAt. A dislike's comment is stored as the reason; a like stores no comment.

6 parameters
  • runId (string, required) The run's id (a UUID).
  • opportunityId (string, required) Your identifier for the record, e.g. the row's matchedRecordId. Stored as given.
  • rowIndex (integer, required) The row's rowIndex in the results grid. Must be a JSON number.
  • sentiment (string, required) "like" or "dislike".
  • mode (string) The pass the row came from: "ai", "data", or "" for enrichment (the default when omitted). Any other value is a 400.
  • comment (string) Why the row was disliked; trimmed and cut to 2,000 characters. Ignored for a like.
DELETE/api/v1/lead-generation/runs/:runId/feedback

Clear Run Feedback

Clears your verdict on one row of one pass. Returns 200 whether or not a verdict existed.

3 parameters
  • runId (string, required) The run's id (a UUID).
  • rowIndex (integer, required) The row's rowIndex, 0 or more (400 otherwise).
  • mode (string) "ai", "data", or empty/omitted for the enrichment pass. Any other value is a 400.

Cookies on GTM Scoop

Essential cookies keep you signed in and the site secure, and are always on. Optional cookies (Google Analytics) help us understand how the site is used. They are on by default, except in the EU/EEA, the UK and Switzerland, where they stay off until you choose Accept All Cookies; choose Essential Cookies Only to turn them off. We do not use advertising cookies and we do not sell or share your personal information. The site works the same whichever you choose. We keep a record of your choice with the date, your IP address and the page you were on. Cookie Policy · Privacy Policy