Product Importer Statistics
The Product Importer Statistics endpoint provides the statistics of Import Job for partners who use Product Importer API to import their products into Criteo's catalog system.
Statistics object
The API endpoint offers the following parameters:
Field Name | Type | Description |
---|---|---|
startDate | Datetime | Start of streaming products collection |
endDate | Datetime | End date of streaming products collection |
total | Long (int64) | The total number of products at endDate moment |
variant | Long (int64) | The total number of product variants at endDate moment |
displayable | Long (int64) | The total number of displayable products at endDate moment |
nonDisplayable | Long (int64) | The total number of non-displayable products at endDate moment |
added | Long (int64) | The number of inserted products during the period between startDate and endDate |
deleted | Long (int64) | The number of deleted products during the period between startDate and endDate |
updated | Long (int64) | The number of updated products during the period between startDate and endDate |
blacklisted | Long (int64) | The total number of blacklisted products at endDate moment |
outOfStock | Long (int64) | The total number of out-of-stock products at endDate moment |
missingImage | Long (int64) | The total number of products with a missing image at endDate moment |
missingUrl | Long (int64) | The total number of products with a missing URL at endDate moment |
missingPrice | Long (int64) | The total number of products with a missing price at endDate moment |
missingName | Long (int64) | The total number of products with a missing name at endDate moment |
missingDescription | Long (int64) | The total number of products with a missing description at endDate moment |
Get statistics
https://api.criteo.com/preview/catalog/stats/merchants/{merchantId}?lastNumHours=XX
You can use this endpoint to retrieve the statistics based on two parameters:
Parameter | Required / Optional | Default value | Description |
---|---|---|---|
merchantId | Required | - | The merchantId to retrieve the stats |
lastNumHours | Required | default: 24 max: 1000 | The last number of hours from NOW to query the statistics records. |
GET /catalog/stats/marchants/3456?lastNumHours=100
Sample Response:
{
"data": {
"statisticsRecordList": [
{
"startDate": "2023-03-02T10:00:00.000Z",
"endDate": "2023-03-02T11:00:00.000Z",
"total": "3622816",
"displayable": "3622815",
"nonDisplayable": "1",
"inserted": "1002",
"deleted": "1",
"updated": "2",
"blacklisted": "0",
"outOfStock": "1",
"missingImage": "0",
"missingUrl": "0",
"missingPrice": "0",
"missingName": "0",
"missingDescription": "40"
},
{
"startDate": "2023-03-02T09:00:00.000Z",
"endDate": "2023-03-02T10:00:00.000Z",
"total": "3621812",
"displayable": "3621811",
"nonDisplayable": "1",
"inserted": "1002",
"deleted": "1",
"updated": "2",
"blacklisted": "0",
"outOfStock": "1",
"missingImage": "0",
"missingUrl": "0",
"missingPrice": "0",
"missingName": "0",
"missingDescription": "40"
}]
}
}
{
"errors": [
{
"traceId": "00000000000000003632af6188a75e4c",
"type": "validation",
"code": "json-format",
"instance": "/catalog/stats/merchants/72532",
"title": "A request was rejected due to one or more errors.",
"detail": "lastNumHours: must be between 1 and 1000"
}
],
"warnings": []
}
Responses
Response | Description |
---|---|
200 | The successful response of GET stats request. |
404 | Not found. |
401 | Unauthorized. Allowed error types and errors: [(type="authentication", code="not-authenticated")] |
403 | Forbidden. Allowed error types and errors: [(type="authorization", code="not-authorized")] |
429 | Too Many Requests. Allowed error types and errors: [(type="availability", code="too-many-requests")] |
500 | Internal Server Error. Allowed error types and errors: [(type="availability", code="internal-error")] |
503 | Service Unavailable. Allowed error types and errors: [(type="availability", code="service-unavailable")] |
Updated 10 days ago