Skip to main content
GET
Get a Template Run
Returns the run’s status and progress. Once status is completed or partial, rows holds the results. Add ?rows=false while polling to leave the rows out.
A finished run of Google Maps leads for dentists in Lekki, Lagos, with the first of its 20 rows shortened:

Rows

Each row has every field the site returned, not only the columns the dashboard shows. For Google Maps that’s about 50 fields per place (hours, photos, review topics, address parts and more). The template’s columns from Get a Template list the fields the table shows by default, with the path to each one.

Other fields

  • failures: pages that couldn’t be read, with the reason. They aren’t charged.
  • followStep: on templates with a second step switched on (such as Find emails and social links), how many websites it checked and what it cost. The run stays running until the second step has finished, and its fields are merged into each row.
  • summary: on rank trackers, how many keywords or points ranked and the average position.
  • job: the tool job behind the run. For a crawl or parse template, the full result is at that tool’s own endpoint, such as GET /crawl/{jobId}.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

runId
string
required

The run's ID.

Query Parameters

rows
boolean
default:true

Set to false to leave the rows out (faster while polling).

Response

The run.

status
enum<string>
Available options:
success
run
object