Skip to main content

The basics

BrowserBee requests are usually built from the same three moving parts:

  • an HTTP method
  • a resource path that may contain path parameters
  • optional query string parameters for filtering or shaping a response

Understanding those parts once makes the API Reference easier to read everywhere else.

How to read an endpoint shape​

Take this example:

GET /browsers/\{profile_key\}

It tells you:

  • GET is the HTTP method
  • /browsers is the resource family
  • {profile_key} is a path parameter you must replace with a real identifier

Common request-building mistakes​

  • using the right path with the wrong method
  • forgetting to replace a placeholder path parameter
  • placing a required path value in the query string instead
  • treating optional query parameters as part of the path

Next steps​