GET/v1/run_data

Run data

Retrieve the processed data from a completed project run

Riveter·Free

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "riveter",
  path: "/v1/run_data",
  query: {
    "run_key": "example"
  }
});

console.log(output);

Query parameters

run_keyrequired

string

The run key (UUID) of the project run to retrieve data for

Response

status.status

string

status.credits_used

number

status.project_name

string

status.project_uuid

string

status.error_message

null

status.completed_cells

number

status.enrichment_name

string

status.enrichment_uuid

string

status.not_found_cells

number

status.riveter_app_link

string

status.completion_estimate.elapsed_seconds

number

status.completion_estimate.percent_complete

string

status.completion_estimate.estimated_seconds_remaining

null

status.completion_estimate.estimated_time_of_completion

null

status.total_cells_expected

number

message

string

run_key

string

formatted_data.person.0.value

string

formatted_data.photo_url.0.value

string

request_status

string