> ## Documentation Index
> Fetch the complete documentation index at: https://developers.criteo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# /experimental/retail-media/diagnostics/line-item-checks
> Retrieve external diagnostics for a line item
Retrieves a diagnostic report for a line item accessible to the caller.
## OpenAPI
````yaml https://api.criteo.com/experimental/retailmedia/open-api-specifications.json get /experimental/retail-media/diagnostics/line-item-checks
openapi: 3.0.1
info:
title: Criteo API
description: Criteo API - RetailMedia
version: Experimental
servers:
- url: https://api.criteo.com
security:
- oauth: []
tags:
- name: Accounts
- name: Analytics
- name: Audience
- name: Balance
- name: Campaign
- name: Catalog
- name: Gateway
- name: ThirdPartyAccounts
paths:
/experimental/retail-media/diagnostics/line-item-checks:
get:
tags:
- Campaign
summary: /experimental/retail-media/diagnostics/line-item-checks
description: |-
Retrieve external diagnostics for a line item
Retrieves a diagnostic report for a line item accessible to the caller.
operationId: GetExternalLineItemChecks
parameters:
- name: as-approved
in: query
description: >-
When true, evaluates the approved Onsite Display line item when one
exists. This parameter has no effect for Sponsored Products line
items.
schema:
type: boolean
default: true
- name: fields
in: query
description: >-
A comma-separated list of optional attributes to return: context,
issues, and parameters. Fixed attributes status and systemData are
always returned; requesting them produces a warning.
schema:
type: string
- name: line-item-id
in: query
description: The external identifier of the line item to evaluate.
schema:
type: string
responses:
'200':
description: The diagnostic report for the requested line item.
content:
application/json:
schema:
$ref: '#/components/schemas/LineItemCheckCollectionResponse'
security:
- oauth:
- RetailMedia_Campaign_Read
components:
schemas:
LineItemCheckCollectionResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/LineItemCheckResource'
nullable: true
errors:
type: array
items:
$ref: '#/components/schemas/CommonProblem'
nullable: true
warnings:
type: array
items:
$ref: '#/components/schemas/CommonProblem'
nullable: true
additionalProperties: false
description: >-
A collection response containing line item diagnostic results and any
problems.
LineItemCheckResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/LineItemCheck'
type:
type: string
nullable: true
additionalProperties: false
description: A resource containing one line item diagnostic result.
CommonProblem:
type: object
properties:
code:
type: string
description: A machine-readable error code, expressed as a string value.
nullable: true
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem
nullable: true
instance:
type: string
description: A URI that identifies the specific occurrence of the problem.
nullable: true
source:
type: object
additionalProperties:
type: string
description: >-
A machine-readable structure to reference to the exact location(s)
causing the error(s)
nullable: true
stackTrace:
type: string
nullable: true
title:
type: string
description: A short human-readable description of the problem type
nullable: true
traceId:
type: string
description: The request correlation ID this problem comes from.
nullable: true
traceIdentifier:
type: string
description: >-
The request correlation ID this problem comes from. (deprecated, use
traceId instead)
nullable: true
type:
enum:
- unknown
- access-control
- authentication
- authorization
- availability
- deprecation
- quota
- validation
type: string
description: The problem's category.
nullable: true
description: Common problem object.
LineItemCheck:
required:
- status
- systemData
type: object
properties:
context:
$ref: '#/components/schemas/DiagnosticContext'
issues:
type: array
items:
$ref: '#/components/schemas/DiagnosticIssue'
nullable: true
parameters:
type: object
additionalProperties:
type: string
nullable: true
status:
$ref: '#/components/schemas/CheckStatus'
systemData:
$ref: '#/components/schemas/SystemData'
additionalProperties: false
description: The servability diagnostic result for a line item.
nullable: true
DiagnosticContext:
required:
- accountId
- campaignId
- retailerId
- lineItemId
- campaignType
- buyType
type: object
properties:
accountId:
type: string
buyType:
enum:
- Unknown
- Auction
- PreferredDeals
- Sponsorship
type: string
campaignId:
type: string
campaignType:
enum:
- Unknown
- SponsoredProducts
- OnsiteDisplay
type: string
lineItemId:
type: string
retailerId:
type: string
additionalProperties: false
description: Identifiers and targeting context used to evaluate a line item.
nullable: true
DiagnosticIssue:
required:
- ruleId
- ruleName
- code
- severity
- tags
- format
- outputParameters
- message
type: object
properties:
code:
type: string
format:
type: string
id:
type: integer
format: int32
nullable: true
message:
type: string
outputParameters:
type: object
additionalProperties:
type: string
parentId:
type: integer
format: int32
nullable: true
ruleId:
type: string
ruleName:
type: string
severity:
enum:
- Unknown
- Error
- Warning
- Info
type: string
tags:
type: array
items:
type: string
additionalProperties: false
description: A rule-based issue that affects line item servability.
CheckStatus:
enum:
- Unknown
- CanFullyServe
- CannotServe
- CanPartiallyServe
type: string
description: The servability result for a line item.
SystemData:
required:
- checkTime
- lineItemCreatedTime
- lineItemUpdatedTime
type: object
properties:
checkTime:
type: string
format: date-time
lineItemCreatedTime:
type: string
format: date-time
lineItemUpdatedTime:
type: string
format: date-time
additionalProperties: false
description: Timestamps associated with the diagnostic evaluation and line item.
securitySchemes:
oauth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.criteo.com/oauth2/token
scopes:
RetailMedia_Accounts_Read: >-
Grants Read access to the capabilities from the Accounts domain,
for RetailMedia applications
RetailMedia_Analytics_Read: >-
Grants Read access to the capabilities from the Analytics domain,
for RetailMedia applications
RetailMedia_Audience_Manage: >-
Grants Manage access to the capabilities from the Audience domain,
for RetailMedia applications
RetailMedia_Balance_Read: >-
Grants Read access to the capabilities from the Balance domain,
for RetailMedia applications
RetailMedia_Campaign_Manage: >-
Grants Manage access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Campaign_Read: >-
Grants Read access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Catalog_Manage: >-
Grants Manage access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_Catalog_Read: >-
Grants Read access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_ThirdPartyAccounts_Manage: >-
Grants Manage access to the capabilities from the
ThirdPartyAccounts domain, for RetailMedia applications
authorizationCode:
authorizationUrl: https://api.criteo.com/oauth2
tokenUrl: https://api.criteo.com/oauth2/token
scopes:
RetailMedia_Accounts_Read: >-
Grants Read access to the capabilities from the Accounts domain,
for RetailMedia applications
RetailMedia_Analytics_Read: >-
Grants Read access to the capabilities from the Analytics domain,
for RetailMedia applications
RetailMedia_Audience_Manage: >-
Grants Manage access to the capabilities from the Audience domain,
for RetailMedia applications
RetailMedia_Balance_Read: >-
Grants Read access to the capabilities from the Balance domain,
for RetailMedia applications
RetailMedia_Campaign_Manage: >-
Grants Manage access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Campaign_Read: >-
Grants Read access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Catalog_Manage: >-
Grants Manage access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_Catalog_Read: >-
Grants Read access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_ThirdPartyAccounts_Manage: >-
Grants Manage access to the capabilities from the
ThirdPartyAccounts domain, for RetailMedia applications
````