Request on Grafana Labs

allHeaders()

Mon, 21 Sep 2026 15:16:28 +0000

allHeaders()

An object of key value pairs made up of HTTP headers associated with the request and the ones that the browser adds (such as cookies). All header names are lower-case.

Returns

Type	Description
`Promise<Record<string, string>>`	A promise that resolves to an object of key value pairs for each header.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const allHeaders = await req.allHeaders();
    console.log(`allHeaders: ${JSON.stringify(allHeaders)}`); // allHeaders: {"user-agent":"Mozilla/5.0...}
  } finally {
    await page.close();
  }
}

frame()

Mon, 21 Sep 2026 15:16:28 +0000

frame()

The Frame that initiated the request.

Returns

Type	Description
Frame	The `Frame` that initiated the request.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const frame = req.frame();
    // ...
  } finally {
    await page.close();
  }
}

headers()

Mon, 21 Sep 2026 15:16:28 +0000

headers()

An object of key value pairs made up of HTTP headers associated with the request.

Returns

Type	Description
`Record<string, string>`	Key value pairs for each header.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const headers = req.headers();
    console.log(`headers: ${JSON.stringify(headers)}`); // headers: {"user-agent":"Mozilla/5.0...}
  } finally {
    await page.close();
  }
}

headersArray()

Mon, 21 Sep 2026 15:16:28 +0000

headersArray()

An array with all the request HTTP headers. Unlike request.allHeaders(), header names are not lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

Returns

Type	Description
`Promise<Array<{ name: string; value: string }>`	A promise that resolves to an array of all the request HTTP headers.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const headersArray = await req.headersArray();
    console.log(`headersArray: ${JSON.stringify(headersArray)}`); // headersArray: [{"name":"Accept-Language","value"...}]
  } finally {
    await page.close();
  }
}

headerValue(name)

Mon, 21 Sep 2026 15:16:28 +0000

headerValue(name)

Returns the value of the header matching the name. The name is case insensitive.

Returns

Type	Description
`Promise<string \| null>`	A promise that resolves to the value of the header matching the name, otherwise `null`.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const headerValue = await req.headerValue('accept-language');
    console.log(`headerValue: ${headerValue}`); // headerValue: en-US
  } finally {
    await page.close();
  }
}

isNavigationRequest()

Mon, 21 Sep 2026 15:16:28 +0000

isNavigationRequest()

Returns a boolean stating whether the request is for a navigation.

Returns

Type	Description
boolean	Boolean stating whether the request is for a navigation.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const isNavReq = req.isNavigationRequest();
    console.log(`isNavReq: ${isNavReq}`); // isNavReq: true
  } finally {
    await page.close();
  }
}

method()

Mon, 21 Sep 2026 15:16:28 +0000

method()

Request’s method (GET, POST, etc.).

Returns

Type	Description
string	Request’s method name.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const method = req.method();
    console.log(`method: ${method}`); // method: GET
  } finally {
    await page.close();
  }
}

postData()

Mon, 21 Sep 2026 15:16:28 +0000

postData()

Contains the request’s post body, if any.

Returns

Type	Description
string \| null	Request’s post body, otherwise `null` if none exists.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const postData = req.postData();
    console.log(`postData: ${postData}`); // postData: null
  } finally {
    await page.close();
  }
}

postDataBuffer()

Mon, 21 Sep 2026 15:16:28 +0000

postDataBuffer()

Request’s post body in a binary form, if any.

Returns

Type	Description
ArrayBuffer \| null	Returns an `ArrayBuffer` with request’s post data or `null` if no post data.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const postDataBuffer = req.postDataBuffer();
    console.log(`postDataBuffer: ${postDataBuffer}`); // postDataBuffer: null
  } finally {
    await page.close();
  }
}

resourceType()

Mon, 21 Sep 2026 15:16:28 +0000

resourceType()

Contains the request’s resource type as it was perceived by the rendering engine. It will be one of the following: document, stylesheet, image, media, font, script, texttrack, xhr, fetch, eventsource, websocket, manifest, other.

Returns

Type	Description
string	Resource type name.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const resourceType = req.resourceType();
    console.log(`resourceType: ${resourceType}`); // resourceType: Document
  } finally {
    await page.close();
  }
}

response()

Mon, 21 Sep 2026 15:16:28 +0000

response()

Returns the matching Response object, or null if the response was not received due to error.

Returns

Type	Description
`Promise<Response \| null>`	The `Response` object, or `null` if the response was not received due to error.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const response = await req.response();
    // ...
  } finally {
    await page.close();
  }
}

size()

Mon, 21 Sep 2026 15:16:28 +0000

size()

This method returns the size (in bytes) of body and header sections of the Request.

Returns

Type	Description
Promise	Returns Size.

Size

Property	Type	Description
body	number	Size in bytes of the request body.
headers	number	Size in bytes of the headers body.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const size = req.size();
    console.log(`size: ${JSON.stringify(size)}`); // size: {"headers":344,"body":0}
  } finally {
    await page.close();
  }
}

timing()

Mon, 21 Sep 2026 15:16:28 +0000

timing()

Returns resource timing information for the given request. Most of the timing values become available upon the response, responseEnd becomes available when request finishes.

Returns

Type	Description
ResourceTiming	Returns ResourceTiming.

ResourceTiming

Property	Type	Description
statTime	number	Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
domainLookupStart	number	Time immediately before the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
domainLookupEnd	number	Time immediately after the browser ends the domain name lookup for the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
connectStart	number	Time immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
secureConnectionStart	number	Time immediately before the browser starts the handshake process to secure the current connection. The value is given in milliseconds relative to `startTime`, -1 if not available.
connectEnd	number	Time immediately after the user agent establishes the connection to the server to retrieve the resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
requestStart	number	Time immediately before the browser starts requesting the resource from the server, cache, or local resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
responseStart	number	Time immediately after the browser receives the first byte of the response from the server, cache, or local resource. The value is given in milliseconds relative to `startTime`, -1 if not available.
responseEnd	number	Time immediately after the browser receives the last byte of the resource or immediately before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to `startTime`, -1 if not available.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const timing = await req.timing();
    console.log(`timing: ${JSON.stringify(timing)}`); // timing: {"startTime":534898988.85297775,...}
  } finally {
    await page.close();
  }
}

url()

Mon, 21 Sep 2026 15:16:28 +0000

url()

URL of the request.

Returns

Type	Description
string	URL of the request.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');
    const req = res.request();

    const url = await req.url();
    console.log(`url: ${url}`); // url: https://test.k6.io/
  } finally {
    await page.close();
  }
}