List tasks

GET

/serp/tasks

const url = 'https://api.seo-checker.com.ua/v1/serp/tasks?limit=20&offset=0';
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://api.seo-checker.com.ua/v1/serp/tasks?limit=20&offset=0' \
  --header 'Authorization: Bearer <token>'

List your organization’s tasks, newest first.

Authorizations

apiKey

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

offset

integer

Responses

200

A page of tasks.

application/json

object

tasks

Array<object>

object

task_id

string format: uuid

type

string

Allowed values: serp_full

status

Lifecycle: queued → running → done | error. A cache hit is created directly as done.

string

Allowed values: queued running done error

request

object

type

Task type. Only serp_full (full organic SERP) is available today.

string

default: serp_full

Allowed values: serp_full

keyword

required

The search query.

string

>= 1 characters

region

required

Region code from GET /regions.

string

device

string

default: desktop

Allowed values: desktop mobile tablet

depth

Number of result pages to crawl (10 results per page).

integer

default: 1 >= 1 <= 5

result

One of:

object
null

object

keyword

string

region

string

device

string

total_results

Approximate total results reported by Google.

integer

items

Array<object>

object

position

1-based organic rank.

integer

url

string format: uri

title

string

snippet

string | null

displayed_url

string

error

One of:

object
null

object

code

Stable machine-readable code

string

message

string

task_id

string | null format: uuid

cost

Credits charged for this task.

integer

created_at

string format: date-time

started_at

string | null format: date-time

finished_at

string | null format: date-time

total

Total task count for the org.

integer

Example

{
  "tasks": [
    {
      "type": "serp_full",
      "status": "queued",
      "request": {
        "type": "serp_full",
        "keyword": "best running shoes",
        "region": "us",
        "device": "desktop",
        "depth": 1
      }
    }
  ]
}

401

Missing or invalid API key.

application/json

object

error

object

code

Stable machine-readable code

string

message

string

task_id

string | null format: uuid

Examples

{
  "error": {
    "code": "apikeys.missing",
    "message": "API key required"
  }
}

{
  "error": {
    "code": "apikeys.invalid",
    "message": "API key is invalid or revoked"
  }
}

429

Per-key rate limit exceeded.

application/json

object

error

object

code

Stable machine-readable code

string

message

string

task_id

string | null format: uuid

Examples

default

{
  "error": {
    "code": "serpapi.rate_limited",
    "message": "Rate limit exceeded"
  }
}

Headers

Retry-After

integer

Seconds to wait before retrying (on 429).

X-RateLimit-Limit

integer

Requests allowed per minute for this key.

X-RateLimit-Remaining

integer

Requests remaining in the current window.

X-RateLimit-Reset

integer

Unix epoch second when the window resets.