There are a few options available in order to design automated checks for the account`s data integration status.
By the SYNC REQUEST response
By an endpoint check
SYNC Request Response
If desired, your process can read the response from the SYNC REQUEST. The response will be of type JSON:
in case of error: the message
in case of success: a combination key-value: {“taskId”:”task value”}. withthe <taskId> you can make request to <endpoint>/task/status/<taskId>
Account review (WEB)
You can review the status of the triggered events in the Account page: <endpoint>/account like :
https://boxalino-di-process-krceabfwya-ew.a.run.app/account
...
Status Code | Meaning | ||
|---|---|---|---|
STATUS CODES DURING SYNC REQUESTS | |||
SYNC OK | the data content was exported to SOLR; | SYNC FAIL | the data update failed in SOLR or before |
SYNC REQUEST | a SYNC REQUEST was done (<endpoint>/sync); once the SYNC REQUEST is received, the compute process starts | ||
SYNC FAIL | the data update failed; | ||
SYNCPRODUCT FAIL | fail of SYNC REQUEST during compute | ||
STOP SYNC | the SYNC REQUEST was stopped (for ex: the content quota was not reached: min X products to be synced, OR the doc_X table is empty) | ||
DENIED SYNC | it appears in the case of product delta sync requests when the doc_X content is too much (ex: over 1GB BQ table size). | ||
BIG SOLR CONTENT | generating the SOLR file for SOLR export from the doc_X_<mode>_<tm> file | ||
SOLRSYNC REQUEST | exporting the solr-compute file (above) to SOLR for sync | ||
DISPATCHED SYNC REQUEST | the BQ compute process log (for dispatched requests) | ||
RESYNCACCOUNT REQUEST | re-sync request (triggered internally, on client request); | ||
SYNCCHECK OK | a synccheck request was done (<endpoint>/sync/check); this is done for ex for D/I to access the last SYNC OK status for the account and type | ||
FAIL AUTH | authentication headers are invalid / not a match for the account | ||
FAIL SOLR EXPORT | the export of the generated file failed (data index not updated) | ||
STATUS CODES DURING LOAD REQUESTS | |||
LOAD OK | the doc_X data structure was loaded succesfully in BQ | ||
LOAD REQUEST | a LOAD REQUEST was received (<endpoint>/load); once the LOAD REQUEST is received it: | ||
FAIL BQ LOAD | BQ load step failed | ||
LOADBYCHUNK REQUEST | a LOAD BY CHUNK request was received. when this happens - it loads the content in a GCS file (doc_<type>_<mode>_<tm>-<chunk>.json) | ||
LOADBYCHUNK OK | the GCS file (doc_<type>_<mode>_<tm>-<chunk>.json) was created | ||
LOADBYCHUNK FAIL | the GCS file was not properly loaded | ||
FAIL GCS | the GCS bucket / content failed to generate | ||
LOADBQ REQUEST | loads all the chunk files in BQ | ||
LOADBQ OK | succesfully loaded the doc_<type> content in BQ; | ||
LOADBQ FAIL | the BQ table was unable to generate based on the available doc_<type>_<mode>_<tm>-*.json content | ||
...
The requested link has the following structure:
<di-process-endpoing>/item/<API-Key-admin>/<data-index>/<type>/<mode>/<field>/<value>
| 1 | <di-process-endpoing> | |
| 2 | <API-Key-admin> | the API Key with the role (the API Key used for the DI SYNC REQUEST) |
| 3 | <data-index> | dev | prod |
| 4 | <type> | The value of the ex: product | user | order | content |
| 5 | <mode> | F | f |
| 6 | <field> | id | sku | products_group_id |
| 7 | <value> | the value for the given field |
...