Skip to main content

Fetching a Specific Cookie

To retrieve details about a specific cookie for a site, initiate a GET request to the following endpoint:

https://api.platform.illow.io/open-api/v1/cookies/{siteId}/cookie/{cookieName}

This endpoint requires the following attributes in the query parameters:

Query Parameters

PropertyTypeDescription
siteIdstringThe unique ID created by illow for your site
cookieNamestringThe name of the requested cookie

Response

The API will provide one of the following status codes:

  • 200: Successfully retrieved the requested cookie.

Response Format: JSON

PropertyTypeDescription
namestringThe name of the cookie
domainstringThe domain of the cookie
expiresnumberExpiration date of the cookie. Uses -1 if the cookie doesn't expire.
categorystringThe category of the cookie. Can be one of preferences, marketing, statistics, or Unclassified
descriptionstringAdditional information about the cookie
isOptInbooleanIndicates if the cookie is an opt-in cookie
wildcardMatchbooleanIndicates whether the cookie allows wildcard matches in the domain and path fields
  • 404: Cookie not found.
  • 500: Internal server error. The request has failed.

Example

The following example illustrates the response of a GET request for a cookie named "session_id":

{
"name": "session_id",
"domain": "example.com",
"expires": 1689467134,
"category": "Statistics",
"description": "This cookie collects statistical data for website analytics.",
"isOptIn": true,
"wildcardMatch": false
}