Guardian Server API

Guardian Server API enables you to get more information about your visitors or about individual detection events.

Server API enables you to get more information about individual detection events (using the /events endpoint). Server API must be used only from the server side; it was never designed to be and must not be used from the client side (i.e. browsers, mobile devices).

Server API requests are not billed and do not count towards your monthly allowance.

The following Server APIs are available:

• /request/event/:event_id

  • GET a detailed payload for a single event defined by an event_id

See Also

• To identify the browsers that visit your web application, see our documentation for Getting Started.

Regions

The server API is available in the Global, EU and Asia (Mumbai) regions:

Region	Base URL	Server Location
Global	https://api.guardianstack.ai/request/event/{id	Global

Server API SDKs

For a smoother developer experience, we offer typed SDKs for these languages:

• Node SDK

Trying it out

You can try calling the Server API directly from this reference:

1. You are going to need a Secret API Key. You can create one in your Guardian Dashboard > API Keys.

2. To make a request, you will need a requestId of an identification event associated with your workspace. Go to Dashboard > Identification to see your identification events.

3. Scroll down to one of the endpoints, for example, Get visits by requestId.

4. Set Authentication to your secret API key.

5. Set the id path parameter to some requestId from your dashboard.

6. Make sure the Base URL corresponds to the region.

7. Click Try it!

A real API response will appear in the Response section. Alternatively, you can view the prepared response examples there.