Interface ResponseRecord

A single API response record passed to the interceptor after every successful HTTP call made by the pixiv client.

interface ResponseRecord {
    endpoint: string;
    method: HttpMethod;
    requestBody: string | null;
    requestHeaders: string | null;
    responseBody: string;
    responseHeaders: string | null;
    responseType: "JSON" | "TEXT";
    statusCode: number;
    url: string | null;
}

Properties

endpoint: string

API endpoint path (e.g. "/v1/illust/detail").

HTTP method used for the request.

requestBody: string | null

URL-encoded request body for POST requests (null for GET).

requestHeaders: string | null

JSON-serialized request headers (null if unavailable).

responseBody: string

Serialized response body.

responseHeaders: string | null

JSON-serialized response headers (null if unavailable).

responseType: "JSON" | "TEXT"

Whether the response body was parsed as JSON or left as plain text.

statusCode: number

HTTP response status code.

url: string | null

Full request URL including query string (null if unavailable).