# Get Cookie Inventory cookie list for specified audit run

POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies

Endpoint: POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookies
Security: API_Key

## Path parameters:

  - `auditId` (integer, required)
    Unique identification number for web audit
    Example: 107239

  - `runId` (integer, required)
    Unique identification number for web audit or journey run
    Example: 33010

## Query parameters:

  - `page` (integer)
    Number of results page of an endpoint with paginated results

  - `size` (integer)

  - `sortBy` (string)
    Enum: "page_count", "name", "domain", "party_type", "expiration_type", "secure", "same_site", "http_only", "avg_size", "min_duration_in_minutes", "max_duration_in_minutes", "initiator_tag_count", "unique_initiator_count", "partition_key", "cookie_changed_during"

  - `sortDesc` (boolean)
    Controls sorting order

## Request fields (application/json):

  - `pageUrl` (object)

  - `pageUrl.filterType` (string, required)
    Enum: "contains", "regex"

  - `pageUrl.filterValue` (string, required)

  - `pageUrl.negated` (boolean)
    Switches from "contains" to "not contains", and from "matches regex" to "does not match regex". Supported only by Page Summary for now

  - `finalPageUrl` (object)

  - `pageTitle` (object)

  - `pageTitle.filterValue` (string, required)
    Page title as displayed by browser
    Example: "ObserveP"

  - `initialPageStatusCode` (object)

  - `initialPageStatusCode.negated` (boolean, required)
    Switches from  to , and from  to

  - `finalPageStatusCode` (object)

  - `combinedPageStatusCode` (string)
    -  - initial or final URL are ,
-  - initial URL is  or  and final URL is
    Enum: "broken", "good"

  - `pageLoadTime` (object)
    Page load time in milliseconds. Should have  and/or  properties defined.  is inclusive and  is exclusive.  should be less than .

  - `pageLoadTime.min` (integer)

  - `pageLoadTime.max` (integer)

  - `pageSize` (object)
    Page size in bytes. Should have  and/or  properties defined.  is inclusive and  is exclusive.  should be less than .

  - `redirectCount` (object)
    Number of redirects for a page. Should have  and/or  properties defined.  is inclusive and  is exclusive.  should be less than .

  - `hasBrokenLinks` (boolean)

  - `pageUrlMatchingAuditFilterConfiguration` (boolean)

  - `cookieOriginInclusion` (string)
    -  - exclude cookies which were only changed during pre-audit actions
    Enum: "exclude_pre_audit_action_only_cookies"

  - `cookieName` (object)

  - `cookieDomain` (object)

  - `partyType` (string)
    Indicates how much cookie domain is different from its page domain
    Enum: "1st_party", "owned_3rd_party", "3rd_party"

  - `secure` (boolean)

  - `sameSite` (string,null)
    Enum: "None", "Lax", "Strict", "Empty"

  - `cookieSize` (object)
    Cookie size in bytes. Should have  and/or  properties defined.  is inclusive and  is exclusive

  - `allThirdPartyCookies` (boolean)
    Conflicts with , but has higher priority

  - `httpOnly` (boolean)

  - `expirationType` (string)
    Enum: "session", "timestamp"

  - `cookieDuration` (object)
    Cookie duration in minutes. Should have  and/or  properties defined.  is inclusive and  is exclusive. Ignored when expirationType == "session"

  - `initiatorUrl` (object)

  - `initiatorUrlDomain` (object)

  - `anyRelatedTag` (boolean)
    Show all cookies with any related tag

  - `tagId` (integer)
    Tag ID

  - `tagCategoryId` (integer)
    Tag category ID

  - `tagVendorId` (integer)
    Tag vendor ID

  - `partitionKeyIsSet` (boolean)

## Response 200 fields (application/json):

  - `metadata` (object, required)
    Common metadata for iterable

  - `metadata.pagination` (object, required)

  - `metadata.pagination.totalCount` (integer, required)
    Total number of items available from all result pages combined

  - `metadata.pagination.totalPageCount` (integer, required)
    Total number of pages available

  - `metadata.pagination.pageSize` (integer, required)
    Page size - number of items per result page configured by  query parameter or default page size

  - `metadata.pagination.currentPageSize` (integer, required)
    Number of items in current result page

  - `metadata.pagination.currentPageNumber` (integer, required)
    Current page number/ordinal

  - `cookies` (array, required)

  - `cookies.name` (string, required)
    Cookie name

  - `cookies.domain` (string, required)
    Cookie domain; preceding dot removed

  - `cookies.partyType` (string, required)
    Indicates how much cookie domain is different from its page domain
    Enum: "1st_party", "owned_3rd_party", "3rd_party"

  - `cookies.expirationType` (string, required)
    Enum: "session", "timestamp"

  - `cookies.sameSite` (string,null)
    Enum: "None", "Lax", "Strict"

  - `cookies.secure` (boolean, required)

  - `cookies.httpOnly` (boolean, required)

  - `cookies.cookieChangedDuring` (array)
    List of phases during which this cookie was changed, aggregated across all pages
    Enum: "PRE_AUDIT_ACTION", "PAGE_LOAD", "ON_PAGE_ACTION"

  - `cookies.averageSize` (integer,null, required)
    Cookie value size, in bytes. May not be available for old runs

  - `cookies.filteredPageCount` (integer, required)
    Number of pages this cookie was found on

  - `cookies.minDurationInMinutes` (integer)
    Minimum cookie duration in minutes

  - `cookies.maxDurationInMinutes` (integer)
    Maximum cookie duration in minutes

  - `cookies.initiators` (array)

  - `cookies.initiators.initiatorType` (string, required)
    Type of event that created the cookie
    Enum: "HTTP", "APP", "OP_ACTION", "UNKNOWN"

  - `cookies.initiators.tagId` (integer)
    Tag ID

  - `cookies.initiators.urlDomain` (string)
    Domain part of initiator's URL

  - `cookies.initiators.foundDuring` (array, required)
    List of phases during which this initiator was observed
    Enum: "PRE_AUDIT_ACTION", "PAGE_LOAD", "ON_PAGE_ACTION"

  - `cookies.initiators.instanceCount` (integer, required)
    Number of instances of this initiator across all pages

  - `cookies.initiatorTagIds` (array)
    List of tag IDs, associated with initiators that set this cookie

  - `cookies.initiatorTotalCount` (integer)
    Total number of unique initiators that set this cookie

  - `cookies.partitionKey` (string)

## Response 400 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 401 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 404 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)