Analytics Report Details



Copyright 2020 Parsable, Inc

Analytics report types

The Analytics extract API takes a type parameter which selects the output CSV report content, where type is one of: The detailed columns of these CSV reports are described below.

Content of specific report types

Inputs report

Selected by type=inputs

The Inputs report contains field inputs and step completions from jobs. For this report, the time period corresponds to all field inputs and step completions (excluding setting the step or step group as n/a) that occurred during the time period. Note that the time period is applied to the date of the input and is not related to start or completion of a job. Thus, it is possible to generate input values for a given step or field that is not the final value for a completed job. It is a CSV document with the following columns.

Note that the Template Report available via the UI is just an Inputs report with a specific template ID.

Index #Column nameDescriptionExample
1DateDate of input in this row2017-03-01
2TimeTime of input in this row19:25:53
3Time ZoneTime zone for row as a UTC offset; this will change across a daylight adjustmentUTC-07
4Job IDUUID uniquely identifying the job12345678-9ABC-DEF0-1234-56789ABCDEF0
5Job NameName of the job (not unique)
6Job Template NumberUnique index of the template within the job (order added to job)2
7Template IDUUID uniquely identifying the template12345678-9ABC-DEF0-1234-56789ABCDEF0
8Template VersionVersion of template used1
9Template NameName of the template
10Step IDUUID uniquely identifying the global step (may be shared across templates within a job)12345678-9ABC-DEF0-1234-56789ABCDEF0
11Job Step IDUUID uniquely identifying the step within a job12345678-9ABC-DEF0-1234-56789ABCDEF0
12Template Step NumberPosition of the step within the template1.2.3
13Step NameName of the step
14Field IDUUID uniquely identifying the field (may be shared across steps, should be used along with Job Step ID)12345678-9ABC-DEF0-1234-56789ABCDEF0
15Field NameName of the field, Step Completion, or Job Completion
16Field TypeType of the field, or Completion Text, Number, List, Photo, Video, Signature, Completion
17Field ValueValue of the field, or Captured for completions or media types
18Is NaTo indicate if field was marked as N/A or not, 1=N/A
19Executor IDUUID identifying the user reporting the input12345678-9ABC-DEF0-1234-56789ABCDEF0
20Executor NameName of the user
21-ajob paramsOne column for each job parameter, in the same order displayed elsewhere
(a+1)-btemplate paramsOne column for each template parameter, in the same order displayed elsewhere

Issues report

Selected by type=issues

The Issues report contains field inputs from issues on the team. For this report, the time period corresponds to all field inputs and issue open or resolution that occurred during the time period. This may include only parts of some issue executions. It is a CSV document with the following columns.

Index #Column nameDescriptionExample
1DateDate of input in this row2017-03-01
2TimeTime of input in this row19:25:53
3Time ZoneTime zone for row as a UTC offset; this will change across a daylight adjustmentUTC-07
4Issue IDLookup ID uniquely identifying the issue on the teamteam-i-123
5Issue TitleTitle of the issue (not unique)
6Issue PriorityPriority of the issue1
7StatusStatus of the issueOpen or Resolved
8Job IDIf the issue was created on a job, UUID uniquely identifying the job12345678-9ABC-DEF0-1234-56789ABCDEF0
9Job NameIf the issue was created on a job, name of the job
10Job Step Group IDIf the issue was created on a step group, UUID uniquely identifying the step group12345678-9ABC-DEF0-1234-56789ABCDEF0
11Job Step IDIf the issue was created on a step, UUID uniquely identifying the step12345678-9ABC-DEF0-1234-56789ABCDEF0
12Job Step NameIf the issue was created on a step, name of the step
13Issue Template NumberUnique index of the template within the issue (order added to issue)1
14Template IDUUID uniquely identifying the template12345678-9ABC-DEF0-1234-56789ABCDEF0
15Template VersionVersion of template used1
16Template NameName of the template
17Field IDUUID uniquely identifying the field (may be shared across steps, should be used along with Job Step ID)12345678-9ABC-DEF0-1234-56789ABCDEF0
18Field NameName of the field, Issue Open, or Issue Resolution
19Field TypeType of the field, Open, or Resolution Text, Number, List, Photo, Video, Signature, Completion
20Field ValueValue of the field, or Captured for issue status change or media types
21Is NaTo indicate if field was marked as N/A or not, 1=N/A
22UnitsUnit of Measurement of the Field Value
23Executor IDUUID identifying the user reporting the input12345678-9ABC-DEF0-1234-56789ABCDEF0
24Executor NameName of the user
25-ajob (issue) paramsOne column for each job (issue) parameter, in the same order displayed elsewhere
(a+1)-btemplate paramsOne column for each template parameter, in the same order displayed elsewhere

Completion report

Selected by type=completion

The Completion report contains all steps in jobs completed during the time period, with their status (e.g. Complete, Marked N/A) along with estimated start times for the job and all steps. It is a CSV document with the following columns.

Index #Column nameDescriptionExample
1Job Completion DateCompletion date of this job2017-03-02
2Job Completion TimeCompletion time of this job07:52:35
3Time ZoneTime zone for row as a UTC offset; this will change across a daylight adjustmentUTC-07
4Job Start DateStart date of this job2017-03-01
5Job Start TimeStart time of this job19:25:53
6Job DurationDuration of this job12:26:42
7Job IDUUID uniquely identifying the job12345678-9ABC-DEF0-1234-56789ABCDEF0
8Job NameName of the job (not unique)
9Job Template NumberUnique index of the template within the job (order added to job)3
10Template IDUUID uniquely identifying the template12345678-9ABC-DEF0-1234-56789ABCDEF0
11Template VersionVersion of template used1
12Template NameName of the template
13Step Completion DateCompletion date of this step2017-03-01
14Step Completion TimeCompletion time of this step22:33:55
15Step Start DateStart date of this step, approximated based on first view2017-03-01
16Step Start TimeStart time of this step, approximated based on first view21:53:25
17Step DurationDuration of this step00:40:30
18Step IDUUID uniquely identifying the global step (may be shared across templates within a job)12345678-9ABC-DEF0-1234-56789ABCDEF0
19Job Step IDUUID uniquely identifying the step within a job12345678-9ABC-DEF0-1234-56789ABCDEF0
20Template Step NumberPosition of the step within the template1.2.3
21Step NameName of the step
22Step StatusFinal status of the step in the completed jobIncomplete, Complete, Reopened, or Marked N/A
23Executor IDUUID identifying the user setting the status12345678-9ABC-DEF0-1234-56789ABCDEF0
24Starter IDUUID identifying the user starting the step12345678-9ABC-DEF0-1234-56789ABCDEF0
25Executor NameName of the user setting the status
26-ajob paramsOne column for each job parameter, in the same order displayed elsewhere
(a+1)-btemplate paramsOne column for each template parameter, in the same order displayed elsewhere

Job Steps report

Selected by type=job_steps

All steps for a completed job with the final values for input fields. One record for each step within a job. All timestamps are reported as UTC. This report may take a few minutes to generate. It is a CSV document with the following columns.

Index #Column nameDescriptionExample
1Job UuidUUID for the job12345678-9ABC-DEF0-1234-56789ABCDEF0
2Job Lookup IdReadable identifier for a job, generated by ParsableJob-1234
3Job Created AtWhen the job was created2017-01-01 23:59:59
4Job Started AtWhen the job was started2017-01-01 23:59:59
5Job Completed AtLatest timestamp of the job was completed2017-01-01 23:59:59
6Job TitleName of job entered by authorTemperature Inspection
7Step Hierarchy OrderOrdinal position of steps within a job (may show irregularities with offline activity)1
8Step Hierarchy PositionHierarchy of steps and ordinal position using dot notation1.2.3
9Step UuidUUID for a step. A repeated step will have a the same value12345678-9ABC-DEF0-1234-56789ABCDEF0
10Job Step UuidUUID for a step within a job. A repeated step will have a different value12345678-9ABC-DEF0-1234-56789ABCDEF0
11Job Step TitleName of step entered by authorCheck Back Panel Gauges
12Template UuidUUID of the template used. Null if the step is not assigned to a template12345678-9ABC-DEF0-1234-56789ABCDEF0
13Template NameName of template entered by authorMachine X Temperature Check
14Template VersionVersion of template associated with step1
15Step StateFinal status of step when job was completed, not_applicable if the step has no execution datacomplete
16Step Completed AtWhen the step was last marked complete2017-01-01 23:59:59
17Field ValuesJSON of all field values when step was completed, "{}" if no field values recorded{"Gauge A":18}
18Executor IdUUID of user the executed the step12345678-9ABC-DEF0-1234-56789ABCDEF0
19Executor NameName of user the executed the stepMorty Smith

Deviations report

Selected by type=deviations

All deviations with field values when the deviation was created. All timestamps are reported as UTC. It is a CSV document with the following columns.

Index #Column nameDescriptionExample
1Deviation UuidUUID for the deviation12345678-9ABC-DEF0-1234-56789ABCDEF0
2Created AtWhen the deviation was created2017-01-01 23:59:59
3Deviation Kind NameString encoding of the deviation kindDEVIATION_INPUT_NA
4Deviation Kind Display NameHuman readable representation of hte deviation kindStep Input Marked N/A
5Job UuidUUID for the job12345678-9ABC-DEF0-1234-56789ABCDEF0
6Job Lookup IdReadable identifier for a job, generated by ParsableJob-1234
7Job TitleName of job entered by authorTemperature Inspection
8Job Step GuidUUID for a step within a job. A repeated step will have a different value12345678-9ABC-DEF0-1234-56789ABCDEF0
9Job Step TitleName of step entered by authorCheck Back Panel Gauges
10Job Step Group UUIDUUID of the step group if the step is a member of this group12345678-9ABC-DEF0-1234-56789ABCDEF0
11Job Step Group TitleName of step group entered by authorCheck Gauges
12Step Hierarchy OrderOrdinal position of steps within a job (may show irregularities with offline activity)1
13Step Hierarchy PositionHierarchy of steps and ordinal position using dot notation1.2.3
14Field UuidUUID for the field12345678-9ABC-DEF0-1234-56789ABCDEF0
15Field TitleUser generated title for the fieldGauge 10
16Field TypeData type for the input fieldText
17Field String ValueField value if field uses a string typeThis is an input
18Field Number ValueField value if field uses a number type1234
19Field Timestamp ValueField value if field uses a timestamp type2017-01-01 23:59:59
20Field Range LowMinimum expected value for numeric types1
21Field Range HighMaximum expected value for numeric types100
22Field OrderOrdinal position of field within the step1
23Executor IdUUID of user the executed the step12345678-9ABC-DEF0-1234-56789ABCDEF0
24Executor NameName of user the executed the stepMorty Smith