Get benchmark status

GET

/api/v1/benchmarks/{id}

const url = 'https://dashboard.justcrawl.io/api/v1/benchmarks/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.justcrawl.io/api/v1/benchmarks/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Responses

200

Benchmark details

application/json

object

string format: uuid

status

string

Allowed values: pending running completed failed

urls

Array<string>

providerIds

Array<string>

totalProbes

integer

completedProbes

integer

failedProbes

integer

skippedProviders

Array<string>

error

string

nullable

createdAt

string format: date-time

Example

{
  "status": "pending"
}

404

Benchmark not found