Interface DetectedRequest

This describes a single request. It's expected that native platforms de-duplicate requests.

This type is mainly used by RequestData when platforms deliver request data to the dashboard.

Also, please see the following JSON files where this type is used under the requests key:

interface DetectedRequest {
    category?: string;
    entityName?: string;
    eTLDplus1?: string;
    ownerName?: string;
    pageUrl: string;
    prevalence?: number;
    state: StateBlocked | StateAllowed;
    url: string;
}

Properties

category? entityName? eTLDplus1? ownerName? pageUrl prevalence? state url

Properties

Optionalcategory

category?: string

The category to display for this request. For example, 'Advertising'. Note: the Tracker Radar may assign multiple categories, but we would only show one of them. Please refer to existing implementations to see the order in which you should choose.

OptionalentityName

entityName?: string

The display name of the entity this request belongs to, for example: Amazon.com, or Google. NOT Google LLC <- that would be the ownerName

OptionaleTLDplus1

eTLDplus1?: string

The eTLD+1 for this request. For example, if the tracker https://google.com/a.js was loaded in the page https://example.com, then the eTLD+1 for this request would be google.com

OptionalownerName

ownerName?: string

The name of the company this requests belongs to, if one is known. For example Google LLC

pageUrl

pageUrl: string

The full page URL where this request was observed

Optionalprevalence

prevalence?: number

The prevalence of the associated entity - if one is known. For example, 10.2 or 82.8

state

state: StateBlocked | StateAllowed

The state of the request - 'blocked', or 'allowed' with a given reason

Example

When blocked, there're no additional properties (yet):

{ "blocked": {} }

When allowed, 'reason' is always present and will be one of the keys defined in StateAllowed

{
  "allowed": {
    "reason": "adClickAttribution"
  }
}

url

url: string

The full URL of this request

Settings

Member Visibility

On This Page

Properties