Requests

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const requests = await response.json();
console.log(requests);

import requests

response = requests.get(
    'https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests',
    headers={'Authorization': 'Bearer your-jwt-token'}
)

requests_data = response.json()
print(requests_data)

{
  "hasMore": false,
  "records": [
    {
      "sid": "req_abc123def456ghi789jkl012mno",
      "bucketSid": "bkt_xyz789uvw012rst345abc",
      "environmentSid": "env123",
      "contextSid": null,
      "direction": "in",
      "note": null,
      "createdAt": "2023-12-01T10:30:00.000Z",
      "receivedAt": "2023-12-01T10:30:00.100Z",
      "firewall": {
        "blocked": false
      },
      "request": {
        "host": "api.example.com",
        "method": "GET",
        "path": "/users/123",
        "port": 443,
        "url": "https://api.example.com/users/123",
        "queryString": {},
        "headers": {
          "user-agent": "Mozilla/5.0",
          "accept": "application/json"
        },
        "body": null,
        "contentType": null,
        "size": 0
      },
      "response": {
        "statusCode": 200,
        "headers": {
          "content-type": "application/json",
          "content-length": "156"
        },
        "size": 156,
        "body": {
          "id": 123,
          "name": "John Doe",
          "email": "john@example.com"
        },
        "contentType": "application/json"
      },
      "timings": {
        "duration": 245,
        "start": 1701423000000,
        "end": 1701423000245,
        "lookup": 12,
        "socket": 25,
        "upload": 30,
        "connect": 45,
        "response": 200
      }
    }
  ]
}

List Requests

Retrieve all requests captured in a specific bucket.

Path Parameters

string

required

Account identifier (format: acc_ followed by 27 alphanumeric characters)

string

required

Bucket identifier

Headers

string

required

Bearer token for authentication

Response

boolean

Indicates if there are more records to paginate through

array

Show Request Objects

string

Request identifier (format: req_ followed by 27 alphanumeric characters)

string

Bucket identifier this request belongs to

string

Environment identifier (6 character alphanumeric, nullable)

string

Request context identifier (nullable)

string

Request direction: in (inbound) or out (outbound)

string

User-added notes for the request (nullable)

string

ISO 8601 timestamp when request was created

string

ISO 8601 timestamp when request was received

object

Show Firewall Information

boolean

Whether the request was blocked by firewall rules

object

Show Request Details

string

Request host (nullable)

string

HTTP method (nullable)

string

Request path (nullable)

number

Request port (nullable)

string

Full request URL (nullable)

object

Query string parameters

object

Request headers as key-value pairs

any

Request body content

string

Content type of the request (nullable)

number

Size of request payload in bytes (nullable)

object

Show Response Details

number

HTTP status code returned (nullable)

object

Response headers as key-value pairs (nullable)

number

Size of response payload in bytes (nullable)

any

Response body content

string

Content type of the response (nullable)

object

Show Performance Timings

number

Total request duration in milliseconds (nullable)

number

Request start time (nullable)

number

Request end time (nullable)

number

DNS lookup time (nullable)

number

Socket assignment time (nullable)

number

Upload completion time (nullable)

number

Connection establishment time (nullable)

number

Response start time (nullable)

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const requests = await response.json();
console.log(requests);

import requests

response = requests.get(
    'https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests',
    headers={'Authorization': 'Bearer your-jwt-token'}
)

requests_data = response.json()
print(requests_data)

{
  "hasMore": false,
  "records": [
    {
      "sid": "req_abc123def456ghi789jkl012mno",
      "bucketSid": "bkt_xyz789uvw012rst345abc",
      "environmentSid": "env123",
      "contextSid": null,
      "direction": "in",
      "note": null,
      "createdAt": "2023-12-01T10:30:00.000Z",
      "receivedAt": "2023-12-01T10:30:00.100Z",
      "firewall": {
        "blocked": false
      },
      "request": {
        "host": "api.example.com",
        "method": "GET",
        "path": "/users/123",
        "port": 443,
        "url": "https://api.example.com/users/123",
        "queryString": {},
        "headers": {
          "user-agent": "Mozilla/5.0",
          "accept": "application/json"
        },
        "body": null,
        "contentType": null,
        "size": 0
      },
      "response": {
        "statusCode": 200,
        "headers": {
          "content-type": "application/json",
          "content-length": "156"
        },
        "size": 156,
        "body": {
          "id": 123,
          "name": "John Doe",
          "email": "john@example.com"
        },
        "contentType": "application/json"
      },
      "timings": {
        "duration": 245,
        "start": 1701423000000,
        "end": 1701423000245,
        "lookup": 12,
        "socket": 25,
        "upload": 30,
        "connect": 45,
        "response": 200
      }
    }
  ]
}

Get Request

Retrieve details of a specific request.

Path Parameters

string

required

Account identifier

string

required

Bucket identifier

string

required

Request identifier

Headers

string

required

Bearer token for authentication

Response

Returns a single request object with the same structure as described in the List Requests response.

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const request = await response.json();
console.log(request);

{
  "sid": "req_abc123def456ghi789jkl012mno",
  "bucketSid": "bkt_xyz789uvw012rst345abc",
  "environmentSid": "env123",
  "contextSid": null,
  "direction": "in",
  "note": null,
  "createdAt": "2023-12-01T10:30:00.000Z",
  "receivedAt": "2023-12-01T10:30:00.100Z",
  "firewall": {
    "blocked": false
  },
  "request": {
    "host": "api.example.com",
    "method": "GET",
    "path": "/users/123",
    "port": 443,
    "url": "https://api.example.com/users/123",
    "queryString": {},
    "headers": {
      "user-agent": "Mozilla/5.0",
      "accept": "application/json"
    },
    "body": null,
    "contentType": null,
    "size": 0
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "content-type": "application/json",
      "content-length": "156"
    },
    "size": 156,
    "body": {
      "id": 123,
      "name": "John Doe",
      "email": "john@example.com"
    },
    "contentType": "application/json"
  },
  "timings": {
    "duration": 245,
    "start": 1701423000000,
    "end": 1701423000245,
    "lookup": 12,
    "socket": 25,
    "upload": 30,
    "connect": 45,
    "response": 200
  }
}

Update Request

Update details of a specific request (typically used to add notes or modify metadata).

Path Parameters

string

required

Account identifier

string

required

Bucket identifier

string

required

Request identifier

Headers

string

required

Bearer token for authentication

Request Body

string

Add or update notes for the request

Response

Returns the updated request object.

curl -X PUT "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno" \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "This request was flagged for review"
  }'

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer your-jwt-token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    note: 'This request was flagged for review'
  })
});

const request = await response.json();
console.log(request);

{
  "sid": "req_abc123def456ghi789jkl012mno",
  "bucketSid": "bkt_xyz789uvw012rst345abc",
  "environmentSid": "env123",
  "contextSid": null,
  "direction": "in",
  "note": "This request was flagged for review",
  "createdAt": "2023-12-01T10:30:00.000Z",
  "receivedAt": "2023-12-01T10:30:00.100Z",
  "firewall": {
    "blocked": false
  },
  "request": {
    "host": "api.example.com",
    "method": "GET",
    "path": "/users/123",
    "port": 443,
    "url": "https://api.example.com/users/123",
    "queryString": {},
    "headers": {
      "user-agent": "Mozilla/5.0",
      "accept": "application/json"
    },
    "body": null,
    "contentType": null,
    "size": 0
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "content-type": "application/json",
      "content-length": "156"
    },
    "size": 156,
    "body": {
      "id": 123,
      "name": "John Doe",
      "email": "john@example.com"
    },
    "contentType": "application/json"
  },
  "timings": {
    "duration": 245,
    "start": 1701423000000,
    "end": 1701423000245,
    "lookup": 12,
    "socket": 25,
    "upload": 30,
    "connect": 45,
    "response": 200
  }
}

Delete Request

Delete a specific request from the bucket.

This action is irreversible. The request data will be permanently deleted.

Path Parameters

string

required

Account identifier

string

required

Bucket identifier

string

required

Request identifier

Headers

string

required

Bearer token for authentication

Response

string

ID of the deleted request

boolean

Flag indicating the request was successfully deleted

curl -X DELETE "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const result = await response.json();
console.log(result);

{
  "sid": "req_abc123def456ghi789jkl012mno",
  "deleted": true
}

API Documentation

Core Resources

Data Management

Automation

List Requests

Path Parameters

Headers

Response

Get Request

Path Parameters

Headers

Response

Update Request

Path Parameters

Headers

Request Body

Response

Delete Request

Path Parameters

Headers

Response

​List Requests

​Path Parameters

​Headers

​Response

​Get Request

​Path Parameters

​Headers

​Response

​Update Request

​Path Parameters

​Headers

​Request Body

​Response

​Delete Request

​Path Parameters

​Headers

​Response

List Requests

Path Parameters

Headers

Response

Get Request

Path Parameters

Headers

Response

Update Request

Path Parameters

Headers

Request Body

Response

Delete Request

Path Parameters

Headers

Response