This is the API descriptor for the Nomad Hawk API, responsible for tracking and analytics.
This is the documentation for version 1.1.0
of the API. Last update on Mar 20, 2020.
https://nomad.samarkand-global.cn/hawk
This is the API descriptor for the Nomad Hawk API, responsible for tracking and analytics.
This is the documentation for version 1.1.0
of the API. Last update on Mar 20, 2020.
https://nomad.samarkand-global.cn/hawk
Event to track
Success
The input of a NomadOperation, usually it's JSON format.
The name of mapping class.
Raw data of current HTTP request to the third party server, easy for debug.
The number of requests against the third party in one Nomad request.
Invalid input
curl \
-X POST https://nomad.samarkand-global.cn/hawk/track \
-H "Content-Type: application/json" \
-d '{"type":"event","category":"order","label":"order_create_failed","message":"Couldnt create order","location_city":"London","location_country":"United Kingdom","company":"Apple, Inc","value":"https://some.url","value_type":"url","source":"odoo","sales_channel":"Onion (B2C)","user":"vessy","id":"ABC123","items":[{"item_name":"Can of beans","item_price":10.1,"item_quantity":1,"item_category":"Food","item_barcode":55001234567890,"item_currency":"EUR","item_brand":"Apple"}]}'
{
"type": "event",
"category": "order",
"label": "order_create_failed",
"message": "Couldnt create order",
"location_city": "London",
"location_country": "United Kingdom",
"company": "Apple, Inc",
"value": "https://some.url",
"value_type": "url",
"source": "odoo",
"sales_channel": "Onion (B2C)",
"user": "vessy",
"id": "ABC123",
"items": [
{
"item_name": "Can of beans",
"item_price": 10.1,
"item_quantity": 1,
"item_category": "Food",
"item_barcode": 55001234567890,
"item_currency": "EUR",
"item_brand": "Apple"
}
]
}
{
"code": 42,
"message": "string",
"type": "string",
"data": {
"foobar": "string"
},
"connectorResponses": [
{
"input": "{\"product_id\": 12121}",
"operation_name": "GetProductOp",
"api": [
"string"
],
"http_request_raw_data": "-",
"code": 42,
"response": "string",
"response_en": "string",
"platform": "youzan",
"request_count": 1
}
]
}
Store id of tracked event
Event to track
Success
The input of a NomadOperation, usually it's JSON format.
The name of mapping class.
Raw data of current HTTP request to the third party server, easy for debug.
The number of requests against the third party in one Nomad request.
Invalid input
curl \
-X POST https://nomad.samarkand-global.cn/hawk/track/{store_id} \
-H "Content-Type: application/json" \
-d '{"type":"event","category":"order","label":"order_create_failed","message":"Couldnt create order","location_city":"London","location_country":"United Kingdom","company":"Apple, Inc","value":"https://some.url","value_type":"url","source":"odoo","sales_channel":"Onion (B2C)","user":"vessy","id":"ABC123","items":[{"item_name":"Can of beans","item_price":10.1,"item_quantity":1,"item_category":"Food","item_barcode":55001234567890,"item_currency":"EUR","item_brand":"Apple"}]}'
{
"type": "event",
"category": "order",
"label": "order_create_failed",
"message": "Couldnt create order",
"location_city": "London",
"location_country": "United Kingdom",
"company": "Apple, Inc",
"value": "https://some.url",
"value_type": "url",
"source": "odoo",
"sales_channel": "Onion (B2C)",
"user": "vessy",
"id": "ABC123",
"items": [
{
"item_name": "Can of beans",
"item_price": 10.1,
"item_quantity": 1,
"item_category": "Food",
"item_barcode": 55001234567890,
"item_currency": "EUR",
"item_brand": "Apple"
}
]
}
{
"code": 42,
"message": "string",
"type": "string",
"data": {
"foobar": "string"
},
"connectorResponses": [
{
"input": "{\"product_id\": 12121}",
"operation_name": "GetProductOp",
"api": [
"string"
],
"http_request_raw_data": "-",
"code": 42,
"response": "string",
"response_en": "string",
"platform": "youzan",
"request_count": 1
}
]
}