Reporting

Reporting APIs are highly configurable and require object identification prior to use. List, Location, Location Group, User and other IDs may be required.

POST analyticsv2/actionEvidenceSpreadsheetReport

Obtain a CSV output of action status and evidence data, denormalized into a feed friendly format.

Example 
curl --request POST \
  --url https://hostname/analyticsv2/actionEvidenceSpreadsheetReport \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"lids" : "1161,1171,1181",
	"locGroups" : "1191,1201,1211,1221",
	"locations" : "1231,1241,1251",
	"dateFrom" : "2020-06-16",
	"dateTo" : "2020-06-16",
	"statuses" : "NOTSTARTED,STARTED,COMPLETED,ACCEPTED,REFLECTION,PASTDUE,FAIL",
	"download" : "no"
}'
lids Action List IDs (CSV format)
locGroups Location Group IDs
locations Location IDs
dateFrom Start date of report range (ISO date)
dateTo End date of report range (ISO date)
statuses Status types to be included
download Stream to stdout or file download (yes = file, no = stdout)

POST analyticsv2/aggregateTaskListMetricsForLgV2

Obtain Group Action List Status (GALS) data.

Example 
curl --request POST \
  --url https://hostname/analyticsv2/aggregateTaskListMetricsForLgV2 \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"lgId" : "1161",
	"listIdCsv" : "1191,1201,1211,1221",
	"startDate" : "2020-06-16",
	"endDate" : "2020-06-16"
}'
lgId Location Group ID
listIdCsv Action List IDs
startDate Start date of report range (ISO date)
endDate End date of report range (ISO date)

POST analyticsv2/scorecardReport

Scorecard report data.

Example 
curl --request POST \
  --url https://hostname/analyticsv2/scorecardReport \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"lgIdsCsv" : "1161,1171,1181",
	"listId" : "1191",
	"from" : "2020-06-16",
	"to" : "2020-06-16"
}'
lgIdsCsv Location Group IDs, comma separated
listId Action List ID
from Start date of report range (ISO date)
to End date of report range (ISO date)

POST analyticsv2/scorecardLGAggReport

Scorecard Location Group Aggregates data.

Example 
curl --request POST \
  --url https://hostname/analyticsv2/scorecardLGAggReport \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"lgId" : "1161",
	"listId" : "1191",
	"from" : "2020-06-16",
	"to" : "2020-06-16"
}'
lgId Location Group ID
listId Action List ID
from Start date of report range (ISO date)
to End date of report range (ISO date)

POST analyticsv2/rankedMCSITaskScores

Ranks aggregated Survey List response scores by action.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/rankedMCSITaskScores \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"lg_id" : "1161",
	"list_id" : "1191",
	"from" : "2020-06-16",
	"to" : "2020-06-16"
}'
lgId Location Group ID
listId Action List ID
date_start Start date of report range (ISO date)
date_end End date of report range (ISO date)

POST analyticsv2/aggregateLgMetricsForDueDateRange

Aggregate Location Group Metrics for Due Date Range.

Example 
curl --request POST \
  --url https://hostname/analyticsv2/aggregateLgMetricsForDueDateRange \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"lgId" : "1161",
	"taskListIdsCsv" : "1191",
	"dueDateLocnTzFrom" : "2022-09-01",
	"dueDateLocnTzTo" : "2022-09-30"
}'
lgId Location Group ID
taskListIdsCsv Action List ID
dueDateLocnTzFrom Start date of report range (ISO date)
dueDateLocnTzTo End date of report range (ISO date)

POST analyticsv2/aggregateLocationMetricsForTaskListLg

Aggregate Location Metrics for Task List Location Group.

Example 
curl --request POST \
  --url https://hostname/analyticsv2/aggregateLocationMetricsForTaskListLg \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"lgId" : "1161",
	"tlId" : "1191",
	"dueDateLocnTzFrom" : "2022-09-01",
	"dueDateLocnTzTo" : "2022-09-30"
}'
lgId Location Group ID
tlId Action List ID
dueDateLocnTzFrom Start date of report range (ISO date)
dueDateLocnTzTo End date of report range (ISO date)

GET analyticsv2/actionStatusQuantityForLocationGroupWithDateRange

Action Status Quantity For Location Groups with Date Range.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/actionStatusQuantityForLocationGroupWithDateRange \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
	"ed" : "2022-09-22 23:59:59",
	"location_group_id" : "1191",
	"sd" : "2022-08-23 00:00:00"
}'
ed End date of report range (ISO date)
location_group_id Location Group ID
sd Start date of report range (ISO date)

GET analyticsv2/actionStatusPercentageAndCountForLocationGroupsWithDateRange

Action Status Percentage and Count For Location Groups with Date Range.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/actionStatusPercentageAndCountForLocationGroupsWithDateRange \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "desc" : "true",
        "ed" : "2022-09-22 23:59:59",
        "limit" : "10",
        "location_group_id" : "1191",
        "sd" : "2022-08-23 00:00:00"
}'
desc Data Sorted
ed End date of report range (ISO date)
limit Number of datas Showing
location_group_id Location Group ID
sd Start date of report range (ISO date)

GET analyticsv2/dailyActionStatsForLocationGroupWithDateRange

Daily Action Status For Location Group with Date Range.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/actionStatusPercentageAndCountForLocationGroupsWithDateRange \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "ed" : "2022-09-22 23:59:59",
        "location_group_id" : "1191",
        "sd" : "2022-08-23 00:00:00"
}'
ed End date of report range (ISO date)
location_group_id Location Group ID
sd Start date of report range (ISO date)

GET users/userTopLevelLocGroupsContainingLocns

Daily Action Status For Location Group with Date Range.

Example 
curl --request GET \
  --url https://hostname/users/userTopLevelLocGroupsContainingLocns \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "id" : "5371",
        "name" : "joe.user"
}'
id Location Id
name Name of Location

GET analyticsv2/reflectionAcceptedAndFailedWOUpdateCounts

Daily Action Status For Location Group with Date Range.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/reflectionAcceptedAndFailedWOUpdateCounts \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "ed" : "2022-09-30",
        "location_group_id" : "1191",
        "sd" : "2022-09-01"
}'
ed End date of report range (ISO date)
location_group_id Location Group Id
sd Start date of report range (ISO date)

GET analyticsv2/reflectionsResolvedPrematurelyReport

Daily Action Status For Location Group with Date Range.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/reflectionsResolvedPrematurelyReport \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "ed" : "2022-09-30",
        "limit" : "50",
        "location_group_id" : "1191",
        "offset" : "0",
        "sd" : "2022-09-01"
}'
ed End date of report range (ISO date)
limit Number of datas Showing
location_group_id Location Group Id
offset Offset
sd Start date of report range (ISO date)

GET analyticsv2/topReflectedRankings/

Top Reflected Rankings.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/topReflectedRankings \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
Output 
{
"checksum": "2eeb88e6c8665339f19ba1ddf774e41b",
"sizeof": 210,
"status": 200,
"msg": "",
"data": {
   "tasks": [
      {
             "Qty": "10",
             "task_list_id": "12345",
             "task_list_name": "Safety Walk",
             "original_task_id": "123456",
             "task_name": "safety task name"
      },
      {
             "Qty": "10",
             "task_list_id": "12345",
             "task_list_name": "Safety Walk 2",
             "original_task_id": "123456",
             "task_name": "Safety Net 4 - Physical Barriers"
      },
    ],
    "locations": [
         {
             "Qty": "80",
             "lid": "1234",
             "location_name": "App Store Location",
             "location_city": "Tucson",
             "location_state": "AZ",
             "location_country": "USA",
             "location_store_code": "APPS1"
         },
         {
             "Qty": "2",
             "lid": "1234",
             "location_name": "Surveys - Tucson",
             "location_city": "Tucson",
             "location_state": "AZ",
             "location_country": "USA",
             "location_store_code": "V-6945"
         }
    ],
    "users": [
        {
             "Qty": "80",
             "lid": "1234",
             "location_name": "App Store Location",
             "uid": "1234",
             "username": "joeuser"
        },
        {
             "Qty": "2",
             "lid": "1234",
             "location_name": "Surveys - Tucson",
             "uid": "1234",
             "username": "joeuser"
        }
    ]
},
"timestamp": 1699350068,
"datetime": "2023-11-07 04:41:08"
}

GET analyticsv2/orgRollupReport

Daily Action Status For Location Group with Date Range.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/orgRollupReport \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
username Username to Access API
token Token to Access Data from API

GET org/format

Organization Format.

Example 
curl --request GET \
  --url https://hostname/org/format \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "desc" : "Description of Format",
        "id" : "1",
        "name" : "FORMAT NAME",
        "status" : "ACTIVE",
}'
desc Description of Format
id ID of Format
name Name of Format
status Status of Format

POST actionlist/listCompletionCounts

Count for List of Action List Completion.

Example 
curl --request POST \
  --url https://hostname/actionlist/listCompletionCounts \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "dateFrom" : "2022-09-19 00:00:00",
        "dateTo" : "2022-09-19 00:00:00",
        "groupBy" : "list,
        "dateFilterMode" : "LEGACY",
        "statusesCsv" : "NOTSTARTED,STARTED,COMPLETED,ACCEPTED,REFLECTION,PASTDUE,FAIL",
        "templateTypeIdsCsv" : "231,241",
        "taskTypeIdsCsv" : "7",
        "getSurveyInstancesCount" : "true"
}'
dateFrom Start date of report range (ISO date)
dateTo ID of Format
groupBy Type of Grouped Data
dateFilterMode Mode of Date Filter
statusesCsv All Statuses in CSV File
templateTypeIdsCsv Template Type IDs CSV File
taskTypeIdsCsv All Task Type IDs in CSV
getSurveyInstancesCount Total Count of Survey Instances

GET analyticsv2/notificationsReportRollup

Notification Report for Rollup.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/notificationsReportRollup?year={{year}}&month={{month(In-Numbers}}&typeIdsCsv=2 \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \

GET analyticsv2/reportTCLStatusInstance

Report TCL Status Instance

Example 
curl --request GET \
  --url https://hostname/analyticsv2/reportTCLStatusInstance?i={{instance_id}}&l={{location_id}}&tlid={{task_list_id}} \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \

GET analyticsv2/actionListLocationAssignmentDatetimes

Action List Location Assignment Date and Time.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/actionListLocationAssignmentDatetimes/{{location_id}}/{{list_id}}/?cutoffDateStr={{cutoff_date}} \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \

GET analyticsv2/actionHighlights

Action Highlights

Example 
curl --request GET \
  --url https://hostname/analyticsv2/actionHighlights?includeScheduledActions=true&includeSmartActions=true&status=READ \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \

GET analyticsv2/actionStatusLatest30

Last 30 Days Actions Status.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/actionStatusLatest30/?username={{username}}&token={{token}}&status=READ \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \

GET analyticsv2/locationMetaDataAnalytics

Location Meta Data Analytics.

Example 
curl --request GET \
  --url https://hostname/analyticsv2/locationMetaDataAnalytics/{{location_id}}?username={{username}}&token={{token}}&status=READ \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \

GET analyticsv2/orgActionStatusTrailing

Organization Action Status Trailing

Example 
curl --request GET \
  --url https://hostname/analyticsv2/orgActionStatusTrailing?startDate={{start_date}}&endDate={{end_date}} \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \

POST analyticsv2/locationGroupRecap

Organization Action Status Trailing

Example 
curl --request POST \
  --url https://hostname/analyticsv2/locationGroupRecap \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 555-555-1212' \
  --header 'x-auth-user: joe.user' \
  --data '{
        "recapDate" : "2023-11-06",
        "locGroups" : "123, 456, 856",
  }'
recapDate Recap Date
locGroups Location Group IDs