Working with Results Data

Result Data Overview

Following job completion and concatenation (which occurs 10 minutes after the last Synthetic User completes a run), a batch is created in the UI and within reporting. The job results will be available for download against a given Batch ID.

Result History UI

The Result History Table in the Sincera UI provides an at-a-glance insight into the results of a given Private Job. The table will show information relating to start date, end date, number of URLs, number of batches, and the status of the job.

In addition, you can think of the 5 columns as a “funnel” - successful events from the left-most column get added as potential URLs to the next column on the right. The final column outlines the results generated of the Batch.

Results Entry in the Sincera UI

Result History Table Categories

Module	Definition
`Submitted URLs`	No. of unique URLs submitted in your Domain List.
`Eligible URLs`	URLs that are not duplicated or malformed strings.
`Successful Visits`	Count of URLs a SU was able to successfully connect to.
`Support Ads`	Count of Successful Visits that support some form of ad serving technology.
`Results Generated`	Successful visits that return a non-nil payload from the URL.

Result File Options

Row Index

You have the option of specifying that your submitted file contains an Index, which allows for easy joining of source data to the results. This requires users to upload an Index on the URL list that the Private Job uses, as well as specify Use Index in the job configuration.

If an Index is used, it will always be expected in col_0 for your uploaded file, and will always be written to col_0 in the export results file, whether you are in Single File or Standard Output mode.

Strict File Validation

Strict File Validation (SFV) can be enabled on any Private Job that generates result data that is hosted by Sincera. SFV is designed for long-running PrivateJobs with many batches. This mode will monitor batches (the daily job) and prevent any changes to the exported file format. If there are changes, it will prevent the result file from being uploaded until a user manually approves the change. This will help customers avoid inadvertently ingesting unexpected data.

SFV in the Sincera UI

Private Jobs and Batches (sub tasks within PJs, essentially the daily event) each will have a gold shield icon to indicate the presence of SFV. If SFV fails, you can manually approve the updated format and “set” the new format as the go-forward standard, which subsequent batches will be compared against.

SFV Checks

Strict File Validation will check against the following criteria:

consistent file extension .zip or .csv
Inconsistent file format within the extension (.csv inside the .zip)
CSV syntax (same number of commas, no hanging commas)
Presence of header row
Consistent number of header entries
Consistent naming of header row entries
Same number of columns within the export file
Same encoding (ex UTF-8)

Webhook Status

Users have the option of triggering a webhook event upon batch completion. This can be used to trigger an event in another system, or to alert a user that a batch has completed. The webhook will include the Batch ID, the Job ID, and the status of the batch.

In the Result History UI, a webhook icon is present on the batch where it is enabled, and the color of the icon indicates the status of the webhook. A green icon indicates that the webhook has been successfully triggered (returned a 2xx HTTP code), while a red icon indicates that the webhook has failed (returned a 4xx or 5xx error code). A blue icon indicates that the webhook has not been triggered.

Webhook in the Sincera UI

The Results File

The file itself is hosted on the Sincera Platform, but depending on the configured Delivery Options, it could also be emailed or uploaded to an AWS S3 location.

Standard Output

In standard mode, all modules will include a minimum of 3 columns in the output file. These are: URL (in col_0 position) status, (col_1) and the first results value, which is in the col_2 position. Additional metrics are added as columns. All modules utilize the same success and error codes, defined here..

Single-File Output

For customers who are looking to ingest data into a Key Value database like Aerospike, you can select “Single File Output.” The resulting dataset will have the URL as the key (unless you have specified an Index) and each module’s JSON result is a column in the file. This is an efficient way to run multiple modules and return all of the results in JSON in a single row per URL.

Each module will never output more than one “column” of data, and the success / error codes per module are moved inside of each Module’s respective column, as opposed to have a discrete status column per URL.

You can see an example of the SFO output here, as well as examples of each of the Module’s output schema here.

Sending Result Data

Sincera users have the option of sending the results of their Private Jobs to either email-based recipients or to an AWS S3 bucket. The email-based recipients can be either a single email address or a comma-separated list of email addresses. The AWS S3 bucket must be configured with at least two elements of the below:

Naming Private Jobs

You can name the result file for your Private Job. This is helpful if you are creating an Automated Monitoring Job, and want to be able to uniquely identify the results file. You can also use the below variables in the filename to make it more dynamic.

Note that you cannot use file extensions (.csv) in the custom file name. These will be automatically appended by the concatenation process.

Module	Definition
`[batch_id]`	Input the Batch Identifier into the filename.
`[job_start_time]`	The time a given job starting running.
`[original_filename]`	Input the original filename string into your output file name
`[customer_id]`	Write your customer_id as a unique value in the filename of the results file.
`[job_id]`	The unique identifier of the job itself (not the batch)
`[job_name]`	The friendly name you’ve given a job.