GET v1/browser/request/{id}

For more information on browser requests, see here.

The following endpoint allows you to query browser request for your account by ID.

Get a browser request by ID

This endpoint retrieves a browser request by its ID.

GEThttps://api.gaffa.dev/v1/browser/requests/{id}

Authorization

API Key

Path parameters

id*string

The unique identifier of the browser request to retrieve.

Query parameters

Response

200404

The browser request

Body

application/json

idnullable string

ID of the browser request

urlnullable string

URL of the request

proxy_locationnullable string

The proxy location of the request.

statenullable string

The status of the request

credit_usagenullable integer (int32)

The number of tokens used by the request

errornullable string

Why did this request fail

actual_urlnullable string

The actual URL captured, after any redirects.

http_status_codeenum

The http status code for the request.

100101102103200201202203204205206207208226300300301301302302303303304305306307307308400401402403404405406407408409410411412413414415416417421422422423424426428429431451500501502503504505506507508510511

from_cachenullable boolean

If this request was served from the cached

started_atstring (date-time)

The time in UTC when the request started.

completed_atstring (date-time)

The time in UTC when the request finished.

page_load_timestring (timespan)

How long did the page take to fully render.

actionsnullable array of browerRequestActionResponse (object)

Actions carried out and their results

videonullable string

Video url

Request

JavaScriptCurlPython

const response = await fetch('https://api.gaffa.dev/v1/browser/requests/{id}?id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "url": "text",
  "proxy_location": "text",
  "state": "text",
  "credit_usage": 0,
  "error": "text",
  "actual_url": "text",
  "http_status_code": 100,
  "from_cache": false,
  "started_at": "2024-12-04T08:15:03.310Z",
  "completed_at": "2024-12-04T08:15:03.310Z",
  "page_load_time": "text",
  "actions": [
    {
      "id": "text",
      "type": "text",
      "query": "text",
      "custom_id": "text",
      "timestamp": "2024-12-04T08:15:03.310Z",
      "output": "text",
      "error": "text"
    }
  ],
  "video": "text"
}