session_uid string 

Session UUID generated by Trax 

​

client_session_uid string 

Session UUID generated by the client

client_type string 

Options: 

• Trax Mobile

• On-Device

• API

• Fixed Camera

​

project_name string 

Project name as provided by Trax

​

store_number string 

Client store unique identifier

​

external_route_id string 

Client route unique identifier

​

session_date string (YYYY-MM-DD) 

Visit date in local time zone

​

session_start_time number (Unix Epoch Time timestamp) 

The Unix Epoch Timestamp of the session start time as provided by the client application

​

session_end_time number (Unix Epoch Time timestamp) 

The Unix Epoch Timestamp of the session end time as provided by the client application. This value is empty in case: 

• Session did not begin to upload

• User did not click on the "End Visit" button

​

local_tz_offset  number

The local timezone offset from UTC in minutes (e.g. for PST will be -420), i.e., the offset between local time on the mobile device and UTC time

​

visit_uploading_end_time number (Unix Epoch Time timestamp) 

The Unix Epoch Timestamp of the last image in the session uploaded end time. This value will be empty if the last image in the session didn't finish uploading 

​

visitor_identifier string 

The user email 

​

visitor_service_type string 

Options: 

• null

• regular

• live only 

• live first

​

visit_type_uid string 

Visit UUID generated by trax

​

visit_type_name string 

Visit type name as provided by Trax

​

GPS_coordinates_latitude float 

Latitude coordinate of the visits as captured by the GPS. It is calculated as the median of all the GPS coordinates captured in the different scenes

​

GPS_coordinates_longitude float 

Longitude coordinate of the visits as captured by the GPS. It is calculated as the median of all the GPS coordinates captured in the different scenes

​

store_GPS_coordinates_latitude float 

Latitude coordinate of the visit store as entered in the DB

​

store_GPS_coordinates_longitude float 

Longitude coordinate of the store as entered in the DB

​

device_model string 

Device Model by which the visit was conducted

​

application_version string 

Application version of the mobile device used in the visit

​

session_closed_by_TTL number 

Options: 

• 1 - Session is closed by Time To Leave service

• 0 or null - Session is closed normally 

​

partial_GPS_coordinates boolean 

Options: 

• true - Some probes do not have GPS coordinates identified

• false - All probes have GPS coordinates identified 
   

cycles Object[] 

List of project-level visit cycles. Each cycle contains the following fields: 

​

cycle_name string 

Cycle name associated to the visit

​

cycle_start_date string (YYYY-MM-DD)

Cycle start date

​

cycle_end_date string (YYYY-MM-DD)

Cycle end date

​

​

results_metadata object

Additional properties. Contains the following fields: 

​

generation_time number (Unix Epoch Time timestamp)

The Unix Epoch Timestamp of analysis data generation

​

version number 

The report may have versions. For example, if an additional section has been

computed and added to an initial report, another version will be generated

​

status string

Options:

• completed

• partial

Partial reports are automatically generated by Trax when the expected SLA time has passed and some

data from the client has failed to arrive. For example, one or more images from a store visit failed to upload.

If and when the missing data will arrive, the results will be updated. 

​

sections_included String[]

The sections to be included in 'details' 

Note: The data returned is based on the agreement between Trax and the customer

​

blade_output_summary object

Trax's Big Data anomaly detector output, e.g.:

• category_resolutions

  • successful: 1​

  • anomalies: 3

• display_resolutions: 

  • successful: 0

  • anomalies: 1
     

details object

The analysis data. The possible fields are as follows. Note that the data is based on the

agreement between Trax and the customer:

​

images Object[]

A list of scenes objects with image related data, including stitched scene images,

the actual images and image quality issues. Each object will contain the following fields: 

​

scene_id number

Scene ID generated by Trax

​

scene_uid string

Scene UUID generated by Trax

​

scene_status string

Status of the scene that the image is associated with

​

scene_closed_by_TTL number

Options: 

• 1 - The scene is closed by Time To Leave service

• 0  or null - The scene is closed normally

​

client_scene_uid string

Scene ID provided by the client

​

store_area_code string

Store area code (that has been configured in coordination with Trax implementation team)

​

task_uuid string

Task UUID (that has been configured in coordination with Trax implementation team)

task_name string

Task name (that has been configured in coordination with Trax implementation team)

​

task_display_name string

Task display name (that has been configured in coordination with Trax implementation team)

​

task_code string

Task code (that has been configured in coordination with Trax implementation team)

​

thumbnail_url string

URL of a thumbnail image of the stitched scene

​

preview_url string

URL of a preview image of the stitched scene

​

scene_images Object[]

A list of the images comprising the scene. Each object will contain the following fields:​

​

image_uid string

Image UUID generated by the client during the visit

​

capture_time number (Unix Epoch Time timestamp)

Image capture time as provided by the client

​

quality_issues Object[]

Image quality related issues (if any). Should there be any issues, they will appear with the following information:

​

code number 

Error Code

​

value string 

Error value

​

The following are examples of Code - Value pairs. Note that the list of code-value pairs may vary per project

• 1 - Bad capture angle

• 2 - Nothing to tag

• 3 - Too close

• 4 -  Too far

• 5 - Image rotated

• 6 - Blurry

• 8 - Reflection 

• 9 - Suspected Fake

• 13 - Obstacle

• 45 - Other

• 52 - Low Accuracy 

• 64 - Faces visible in image
  ​

image_urls object

URLs of the image stored in different resolutions:

​

original string

URL of the original image sent by the client

​

medium string

URL of the an image compressed to medium size (about X3 smaller than original)

​

small string

URL of the an image compressed to small size (about X5 smaller than original)

​

categories Object[]

A list of categories covered in the visit. Each category will contain the following fields: 

​

id number

Internal Trax ID for the Category​

​

name string

Taken from a list of predefined categories as agreed between Trax and the client

​

anomalies Object[]

A list of anomalies detected by Blade, Trax Big Data anomaly detector. Each one will contain the following fields: 

​

code number

Anomaly code

​

value string

Anomaly value

​

The following are examples of Code - Value pairs. Note that the list of code-value pairs may vary per project

• 40 - Low number of displays

• 41 - Low number of bays

• 42 - Missing required brands

• 43 - Wrong template

• 48 - Partial category 

• 49 - Photo quality issues

• 50 - Low accuracy 

• 56 - Low number of facings
   

recognized_items/live_recognized_items Object[]

A list of regular/live recognition scenes with analyzed data per item. Each item will contain the following fields:

​

scene_id number

Scene ID generated by Trax
 

scene_uid string

Scene UUID generated by Trax

​

client_scene_uid string

Scene ID provided by the client

​

store_area_code string

Store area code (that has been configured in coordination with Trax implementation team)

​

task_uuid string

Task UUID (that has been configured in coordination with Trax implementation team)

​

task_name string

Task name (that has been configured in coordination with Trax implementation team)

​

task_display_name string

Task display name (that has been configured in coordination with Trax implementation team)

​

task_code string

Task code (that has been configured in coordination with Trax implementation team)

​

items/liveItems Object[]

A list of items with item details and aggregated data, regular/live recognition. Each item will contain the following fields:

​

id number

Internal Trax item ID

​

name string

Trax item name

​

short_name string

Short item name

​

code string

EAN or UPC code of the item (Refers to client_code in the pricing section/Get products)

​

type string

Product types:

• SKU

• POS

• Other

• Empty

• Irrelevant

• Brand Obfuscated 

Note: The list and values may vary per project

​

customer_product_id string

Customer product ID

​

client_code string

Client product code (Refers to alt_code in the pricing section/Get products) 

​

item_code string

Client item code 

Refers to the code in the pricing section and item_Code in Get products

​

product_uuid string

Trax product UUID

​

task_display_name string

Task display name (that has been configured in coordination with the Trax implementation team) 

​

count object

The aggregated facing count data per the item within the scene. The object contains the following fields:

​

total number

The total facings count of the item within the scene​

​

front number

The total front facings count of the item within the scene. For regular recognition only

​

side number

The total side facings count of the item within the scene. For regular recognition only

​

back number

The total back facings count of the item within the scene. For regular recognition only

​

top number

The total top facings count of the item within the scene. For regular recognition only

​

bottom number

The total bottom facings count of the item within the scene. For regular recognition only

​

calculations Object[] -  NOTE THIS SECTION IS DEPRICATED! 

A list of calculations as coordinated with the customer. These calculations are KPIs based on KPI Set (score-card) calculations.

Each calculation will contain the following fields:

​

name string

KPI set name

​

kps_score number

KPI total score

​

kps_details Object[]

List of KPI detailed results, each result will contained the following fields:

​

name string

KPI detail name

​

result string

KPI detail result

​

target string

KPI detail target

​

score number or "" (empty string)

KPI detail score

​

kpis/live_kpis Object[]  

A list of KPI/Live KPI and KPI feedback results. Each KPI object will contain the following fields:

​

scene_id number

Trax scene ID for scene level KPI

​

client_scene_id string

Client scene ID for scene level KPI

​

scene_uid string

Trax Scene UUID for scene level KPI

​

name string

KPI name

​

numerator number (whole)

Numerator result for KPI result represented as ratio, or any auxiliary result

​

denominator number (whole)

Denominator result for KPI result represented as ratio, or any auxiliary result

​

result string

KPI result, or any auxiliary result

​

target string

KPI target, or any auxiliary result

​

score string

KPI score, or any auxiliary result

​

weight string

KPI weight, or any auxiliary result

​

entities Object[]

List of entities for which the KPI was calculated. Each entity will contain the following fields:

​

type string

Entity type

​

uid number or string

Entity UUID, as defined for project

​

flexible_target Object[]

Flexible target date range, it will contain the following fields:

​

target_start_date string

Target start date​

​

target_end_date string

Target end date

​

feedback Object[]

KPI feedback made by a user. The structure will contain the following fields:

​

feedback string

Standard KPI feedback message

​

feedback_local string

Local KPI feedback message (customized)

​

feedback_time_local number

The Unix Epoch Timestamp when the feedback was made, in the local timezone

​

delete_time_local number

The Unix Epoch Timestamp when the feedback was deleted, in the local timezone

​

results  Object[]

Nested KPI results. The object structure is the same as the nesting one (all the above)

​

actions Object[]  

A list of actions with relevant data performed by the user. Each action object will contain the following fields:

​

name string

The action type. Currently, only out of stock is supported

​

Type string

Regular or live visit action 

Options:

• Full Recognition

• Live
  ​

Generator KPI string

KPI type used to generate the instances of the actions. For example, "OOS-SKU"

​

Actions Instances Object[]

List of actions instances presented to the user for a certain type. For example, for OOS type a list of instances will be the list of missing

SKUs that need to be replenished. Each action will contain the following fields: 

​

action_id number

KPI type used to generate the instances of the actions. For example, "OOS-SKU"

​

entity_type string

Entity type the action refers to. Currently, only product is supported

​

entity_name string

Entity name the action refers to. Currently, we only support Product, so it will be the name of the product​

​

entity_uid string

Entity UUID, e.g. UUID of missing product

​

entity_code string

Entity code the action refers to. Currently, we support only Product, so it will be the EAN of the product 

​

reason_type string

The type of the presented reason

​

reason_display_name string

Client name of the presented reason 

​

reason_standard_name string

Client standardized name of the presented reason   

​

status string

The status of the action. Two types of statuses are supported: Reviewed (the user handled the certain instance by providing the reason)

and Pending (user did not act and provide a reason for the instance). When the status is Pending, the reason type and reason display name are Null.

​

Generator KPI string

KPI type used to generate the instances of the actions. For example:  "OOS - SKU" ​

​

scene_uid string

Trax Scene UUID the action was captured for

​

validation_actions Object

The validation actions provided by the user. The fields of the object are:

​

validation_method String[]

The list of validation methods set for the action such as "validation-product-photo-close-up", "validation-product-barcode", etc. - defined per project

​

image_capture object

The image details sent by the user as part of the validation method. The object contains the following fields:

​

image_url string

The URL of the original image sent by the user as part of the validation method 

​

image_capture_time string (YYYY-MM-DD HH:MM:SS)

Image capture time as provided by the user

​

barcode_capture object

The barcode details provided by the user as part of the validation method. The object contains the following fields:

​

barcode string

The barcode provided by the user​

​

barcode_validation boolean

true = The barcode matches the barcode in the master data

​

live_actions Object[] 

A list of live actions bound to a particular KPI with related data including the action type and the reason selected by the user.

Each action object will contain the following fields:

​

name string 

The action type. currently out out of stock is supported

​

Type string 

Regular or Live visit action

Options:

• Full Recognition 

• Live
   

generator_kpi string

KPI type used to generate the instances of the actions. For example, "OOS-SKU"

​

actions_instances Object[]

List of actions instances presented to the user for a certain type. For example, for OOS type a list of instances will be the list of missing

SKUs that need to be replenished. Each action will contain the following fields: 

​

action_id string

ID of the action instance. For example, "Fill a certain SKU is considered an instance of the OOS type". Each missing SKU is an instance

​

entity_type string

Entity type the action refers to. Currently, only Product is supported​

​

entity_name string

Entity name the action refers to. Currently, only Product is supported​, so it will be the name of the product

​

entity_uid string

Entity UUID, e.g. UUID of missing product

​

entity_code string

Entity code the action refers to. Currently, only Product is supported​, so it will be the EAN of the product

​

reason_type string

The type of the presented reason

​

reason_display_name string

Client name of the presented reason

​

reason_standard_name string

Client standardized name of the presented reason 

​

status string

The status of the action. Two types of statuses are supported: Reviewed (the user handled the certain instance by providing the reason) 

and Pending (the user did not act and provide a reason for the instance). When the status is Pending, the reason type and reason display name are Null

​

scene_uid string

Scene UUID the action was captured for

​

validation_actions object

The validation actions done by the user. The fields of the object are as follows:

​

validation_method String[]

The list of validation methods set for the action such as "validation-product-photo-close-up", "validation-product-barcode", etc. - defined per project

​

image_capture object

The image details sent by the user as part of the validation method. The object contains the following fields:
 

image_url string

The URL of the original image sent by the user as part of the validation method 

​

image_capture_time string (YYYY-MM-DD HH:MM:SS)

Image capture time as provided by the user

​

barcode_capture object

The barcode details provided by the user as part of the validation method. The object contains the following fields:
 

barcode string

The barcode provided by the user​

​

barcode_validation boolean

true = The barcode matches the barcode in the master data

​

questionnaires Object[]  

Visit's questionnaires data. Each object will contain the following fields:

​

id number  

Internal Trax ID for the questionnaire

​

linked_entity object 

The questionnaire's related entity. It will contain the following fields:​

​

entity string  

Linked entity name: 

• SESSION

• SCENE

​

entity_uid string  

The UUID of the entity​

​

questionnaire Object[]  

List of questions and answers. Each questionnaire object will ​contain the following fields:

​

code string  

Question code

​

question string  

Question text

​

survey_group_name string  

The group name of several questions. The questions appear in the mobile app in the same group

​

question_order number  

Question display order in the mobile app

​

question_type string  

Question type:

• Radio

• Checkbox

• Numeric

• Text

• Radio + Free Text

• Checkbox + Numeric

• Numeric + Numeric

​​

question_additional_attributes Object  

A list of question attributes. These attributes are coordinated with Trax implementation.

​

<key> String  

Attribute name as coordinated with Trax implementation.

​

<value> String  

Attribute name as coordinated with Trax implementation.

​

answer string  

Attribute name as coordinated with Trax implementation.

​

answer_additional_attributes Object  

A list of answer attributes. These attributes are coordinated with Trax implementation.

​

<key> String  

Attribute name as coordinated with Trax implementation.

​

<value> String  

Attribute name as coordinated with Trax implementation.

​

images_path string

Answer images paths separated by comma

​

pricing Object[]  

Items pricing data. Each object will contain the following fields:

​

id number  

Internal Trax ID for the questionnaire

​

name string  

Trax item name

​

local_name string  

Client local item name

​

code string  

EAN or UPC code

​

source string  

This field details the source of the pricing information:

• recognition

• manual
   

price_tag string  

The indication whether the product has a price tag or not:

• Y - There is a price tag for the product

• N - there is no price tag available for the product

​​

client_code string  

Client product code​

​

alt_code string  

Client product alt code

​

product_uuid string  

Trax product UUID

​

promotion boolean  

Is the product in promotion? May be omitted if false

​

price object  

Price details. The object will contain the following fields:

​

median number  

Median - in case of an even sample set we take the minimal value of the two 

​

std number  

Standard deviation