Verifying Data Processing

Catalog items are sent to the Items API and they will flow towards various parts of the Fredhopper or XO platform to enable Crownpeak services. You might require a confirmation of an item being processed or integrated into the offered services. To fulfill this need we provide a Feedback API that can be used to get summaries or detailed item journey information.

Feedback API

The Feedback API is meant for customer integration. The information exposed via this API can be used for triggering alerts or retry strategies on the customer side as well as feeding customer side dashboards or any UI elements.

Catalog activation statistics

GET https://items.attraqt.io/feedback/catalog-version/:version/full/statistics

This endpoint queries statistics for a specified catalog version. The statistics are focused on creation and activation. Note that one catalog could have had multiple activation attempts.

Path Parameters

Name	Type	Description
version	string	The catalog version

Query Parameters

Name	Type	Description
environment	string	Name of the environment
tenant	string	Name of the tenant

200

{
    "catalogCreation": 
        {
            "version": "1",
            "startTimestamp": "2021-04-16T09:37:21.662",
            "endTimestamp": "2021-04-16T09:37:23.628",
            "duration": 1,
            "state": "SUCCESS",
            "message": "Creation of the catalog version #1 succeed // requestId: a21aa652-3c1d-460d-8417-6f17832e4167",
            "receiptId": "a21aa652-3c1d-460d-8417-6f17832e4167"
        }
    "catalogActivations" : [
        {
            "version": "1",
            "startTimestamp": "2021-04-16T09:47:21.662",
            "endTimestamp": "2021-04-16T09:57:23.628",
            "duration": 600,
            "state": "SUCCESS",
            "message": "Activation of the catalog version #1 succeed",
            "receiptId": "a21aa653-3c1d-460d-8417-6f17832e4167"
        },
        ...
    ]
}

Single update feedback

GET https://items.attraqt.io/feedback/catalog-version/:version/updates/:receiptId

This endpoint returns feedback about a specific update, using its unique receiptId.

Path Parameters

Name	Type	Description
receiptId	string	The receiptId for the update
version	string	The catalog version

Query Parameters

Name	Type	Description
environment	string	Name of the environment
tenant	string	Name of the tenant

Headers

Name	Type	Description
Authorization	string	Bearer token containing the following permission:

200

{
  "update": {
    "startTimestamp": "string",
    "endTimestamp": "string",
    "duration": 0,
    "state": "UNKNOWN",
    "message": "string",
    "itemId": "string",
    "receiptId": "string"
  },
  "type": "DATA"
}

Created catalog versions

GET https://items.attraqt.io/feedback/catalog-version

This endpoint returns a history of created catalogs.

Query Parameters

Name	Type	Description
tenant	string	The name of the tenant
environment	string	The name of the environment
from	integer	Positive integer. Defaults to 0.
size	integer	Positive non-zero integer describing the number of elements to show. Must be lower than 100.

Headers

Name	Type	Description
Authorization	string	Bearer token containing the following permission:

200

{
  "catalogCreations": [
    {
      "version": "string",
      "startTimestamp": "string",
      "endTimestamp": "string",
      "duration": 0,
      "state": "UNKNOWN",
      "message": "string",
      "receiptId": "string"
    }
  ]
}

Summary of updates

GET https://items.attraqt.io/feedback/catalog-version/:version/updates/statistics/summary/relative

This endpoint provides a summary of the number of updates processed in the past specified period e.g. in the last hour, in the last 30 minutes. The response groups counts for successful, failed, and still pending updates.

Path Parameters

Name	Type	Description
version	string	The catalog version

Query Parameters

Name	Type	Description
tenant	string	The name of the tenant
environment	string	The name of the environment
lastPeriodValue	integer	A count for a period, with the period unit specified in the lastPeriodUnit. The final time interval cannot be higher than 720 hours ( 30 days )
lastPeriodUnit	string	Available values: SECOND, MINUTE, HOUR </p> Default: SECOND

200

{
  "numberOfSuccesses": 0,
  "numberOfFailures": 0,
  "numberOfPendingUpdates": 0
}

Summary of updates within a time window

GET https://items.attraqt.io/feedback/catalog-version/:version/updates/statistics/summary/absolute

This endpoint provides a summary of the number of update processed within the given time window. The response groups counts for successful, failed, and still pending updates.

Path Parameters

Name	Type	Description
version	string	The catalog version

Query Parameters

Name	Type	Description
tenant	string	The name of the tenant
environment	string	The name of the environment
startTime	string	Must follow the ISO 8601 format. Cannot be in the future.
endTime	string	Must follow the ISO 8601 format. Cannot be in the future. </p> The time interval cannot be higher than 720 hours ( 30 days )

200

{
  "numberOfSuccesses": 0,
  "numberOfFailures": 0,
  "numberOfPendingUpdates": 0
}

Summary of updates with a specified state

GET /feedback/catalog-version/:version/updates/statistics/summary/:updateState/relative

This endpoint returns the number of updates with a certain state with a duration higher than the specified duration parameter. Only updates in the last specified period will be taken into account.

Path Parameters

Name	Type	Description
version	string	The catalog version
updateState	string	Available values are FAILURE, SUCCESS, PENDING

Query Parameters

Name	Type	Description
tenant	string	The name of the tenant
environment	string	The name of the environment
durationValue	integer	Positive non-zero value. The final duration period cannot be higher than 720 hours ( 30 days )
durationUnit	string	Available values: SECOND, MINUTE, HOUR </p> Default: SECOND
lastPeriodValue	integer	Positive non-zero value. The final time interval cannot be higher than 720 hours ( 30 days )
lastPeriodUnit	string	Available values: SECOND, MINUTE, HOUR </p> Default: SECOND

200

{
  "numberOfUpdates": 0
}

Summary of updates with a specified state within a time window

GET https://items.attraqt.io/feedback/catalog-version/:version/updates/statistics/summary/:updateState/absolute

This endpoint returns the number of updates with a certain state with a duration higher than the specified duration parameter. Only updates within the specified time window will be taken into account.

Path Parameters

Name	Type	Description
version	string	The catalog version
updateState	string	Available values are: FAILURE, SUCCESS, PENDING

Query Parameters

Name	Type	Description
tenant	string	The name of the tenant
environment	string	The name of the environment
durationValue	integer	Positive non-zero value. The final duration period cannot be higher than 720 hours ( 30 days )
durationUnit	string	Available values: SECOND, MINUTE, HOUR </p> Default: SECOND
startTime	string	Must follow the ISO 8601 format. Cannot be in the future
endTime	string	Must follow the ISO 8601 format. Cannot be in the future. The final time interval cannot be higher than 720 hours ( 30 days ).

200

{
  "numberOfUpdates": 0
}

List of updates with specified state

GET https://items.attraqt.io/feedback/catalog-version/:version/updates/statistics/details/:updateState/relative

This endpoint returns a list of updates with a certain state with a duration higher than the specified duration parameter. Only updates in the last specified period will be taken into account. Pagination is done by use of the from and size parameters.

Path Parameters

Name	Type	Description
version	string	The catalog version
updateState	string	Available values are: FAILURE, SUCCESS, PENDING

Query Parameters

Name	Type	Description
tenant	string	The name of the tenant
environment	string	The name of the environment
durationValue	integer	Positive non-zero value. The final duration period cannot be higher than 720 hours ( 30 days )
durationUnit	string	Available values: SECOND, MINUTE, HOUR </p> Default: SECOND
lastPeriodValue	integer	Positive non-zero value. The final time interval cannot be higher than 720 hours ( 30 days )
lastPeriodUnit	string	Available values: SECOND, MINUTE, HOUR </p> Default: SECOND
from	integer	Positive integer. Defaults to 0.
size	integer	Positive non-zero integer. Maximum size is 100.

200

{
  "updates": [
    {
      "startTimestamp": "string",
      "endTimestamp": "string",
      "duration": 0,
      "state": "UNKNOWN",
      "message": "string",
      "itemId": "string",
      "receiptId": "string"
    }
  ]
}

List of updates with specified state within a time window

GET https://items.attraqt.io/feedback/catalog-version/:version/updates/statistics/details/:updateState/absolute

This endpoint returns the list of updates with a certain state with a duration higher than the specified duration parameter. Only updates within the specified time window will be taken into account. Pagination is done by use of the from and size parameters.

Path Parameters

Name	Type	Description
version	string	The catalog version
updateState	string	Available values are: FAILURE, SUCCESS, PENDING

Query Parameters

Name	Type	Description
tenant	string	The name of the tenant
environment	string	The name of the environment
durationValue	integer	Positive non-zero value. The final duration cannot be higher than 720 hours ( 30 days )
durationUnit	string	Available values: SECOND, MINUTE, HOUR </p> Default: SECOND
startTime	string	Must follow the ISO 8601 format
endTime	string	Must follow the ISO 8601 format
from	integer	Positive integer. Defaults to 0
size	integer	Positive non-zero integer. Maximum size is 100.

200

{
  "updates": [
    {
      "startTimestamp": "string",
      "endTimestamp": "string",
      "duration": 0,
      "state": "UNKNOWN",
      "message": "string",
      "itemId": "string",
      "receiptId": "string"
    }
  ]
}