Top

Benchmarking

Get Benchmark Subscriptions
GET /app/api/benchmark/list?[account_id=:account_id][&assessment_types=:assessment_types][&active_only=:active_only]
Returns list of benchmark subscriptions available for the API caller account or one of its subaccounts.
Get Benchmark Assessment Test Reults
GET /app/api/benchmark/available_assessment_tests/:benchmark_id?[account_id=:account_id][&tags=:tags]
Returns information about dataset of assessment test results compatible by type with given benchmark. The results returned are grouped by the assessment.
Post Benchmark Calculate
POST /app/api/benchmark/calculate
Pre-calculates benchmark for given dataset of assessment test results.
Get Benchmark Calculated List
GET  /app/api/benchmark/calculated/list?[account_id=:account_id][&max_records=:max_records][&start_record=:start_record]
Returns list of pre-calculated benchmarks for given account. List of pre-calculated benchmarks is sorted by date and time of calculation, the latest records first.
Get Benchmark Calculated Result
GET /app/api/benchmark/calculated/results/:config_id?[max_records=:max_records][&start_record=:start_record][&tags=:tags]
Returns user results for given pre-calculated benchmark. User benchmark result records are sorted by benchmark criteria total match count, the records with highest match count first.
Get Benchmark Calculated Report: Simple
GET /app/api/benchmark/calculated/report/simple/:benchmark_result_id
Downloads simple PDF report on user benchmark result for pre-calculated benchmark.
Get Benchmark Calculated Report: Full
GET /app/api/benchmark/calculated/report/full/:benchmark_result_id
Downloads full PDF report on user benchmark result for pre-calculated benchmark.
Get Benchmark Match Scores
GET /app/api/benchmark/apply/:benchmark_id/:result_id
Returns benchmark match scores for given benchmark applied to specified completed assessment test.
Get Benchmark Report: Simple
GET /app/api/benchmark/apply/report/simple/:benchmark_id/:result_id
Downloads simple PDF report on given benchmark applied to specified completed assessment test.
Get Benchmark Report: Full
GET /app/api/benchmark/apply/report/full/:benchmark_id/:result_id
Downloads full PDF report on given benchmark applied to specified completed assessment test.

Get Benchmark Subscriptions

GET  /app/api/benchmark/list?[account_id=:account_id][&assessment_types=:assessment_types][&active_only=:active_only]

Returns list of benchmark subscriptions available for the API caller account or one of its subaccounts.

HTTP GET Parameters

account_id Data type and length
[optional] the PK3 account ID. If not specified, the method lists benchmark subscriptions available for the API caller account.
assessment_types JSON array
[optional]
{
    assessment_type_list = [...]
}
assessment_type_list Data type and length
list of assessment types. If specified, the method returns only benchmarks compatible with one of the listed assessment types. Supported assessment types are “DISC 24”, “TEAMS” and “VALUES”
active_only Data type and length
[optional] the flag tells the server to return active benchmark subscriptions only. Any nonzero flag value is interpreted as “true”. By default, the method lists active benchmark subscriptions and subscriptions for future periods.

Response: JSON array

benchmark_id Data type and length
benchmark ID.
name Data type and length
benchmark name.
description Data type and length
benchmark description.
types Data type and length
list of assessment types this benchmark is compatible with.
starts_on Data type and length
[yyyy-mm-dd] the day benchmark subscription starts on.
expires_on Data type and length
[yyyy-mm-dd] the day benchmark subscription expires (left empty, if subscription lasts indefinitely).
owner_account_id Data type and length
ID of the account that owns this benchmark (for account-specific benchmarks).

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

	[
	    {
	        "benchmark_id": "Sample Return",
	        "name": "Sample Return",
	        "description": "Sample Return",
	        "types = […]": "Sample Return",
	        "starts_on": "Sample Return",
	        "expires_on": "Sample Return",
	        "owner_account_id": "Sample Return"
	    }
	]


Get Benchmark Assessment Test Results

GET  /app/api/benchmark/available_assessment_tests/:benchmark_id?[account_id=:account_id][&tags=:tags]

Returns information about dataset of assessment test results compatible by type with given benchmark. The results returned are grouped by the assessment.

HTTP GET Parameters

benchmark_id Data type and length
the benchmark ID.
account_id Data type and length
[optional] the PK3 account ID. If not specified, the API caller account is assumed.
tags JSON array
[optional]
{
    tag_list = [...]
}
tag_list Data type and length
list of tags to filter assessment test results dataset by.

Response: JSON array

assessment_id Data type and length
assessment ID.
types Data type and length
list of assessment types.
amount Data type and length
number of assessment test results compatible by type with given benchmark.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

	[
	    {
	        "assessment_id": "Sample Return",
	        "types = […]": "Sample Return",
	        "amount": "Sample Return"
	    },
	    ...
	]


Post Benchmark Calculate

POST  /app/api/benchmark/calculate

Pre-calculates benchmark for given dataset of assessment test results.

HTTP FORM Parameters

account_id Data type and length
[optional] the PK3 account ID. If not specified, the API caller account is assumed.
benchmark_id Data type and length
ID of the benchmark to apply.
assessment_id Data type and length
assessment ID. The benchmark is applied to test results of the given assessment.
tags JSON array
[optional]
{
    tag_list = [...]
}
tag_list Data type and length
list of tags to filter assessment test results dataset by.

Response: JSON array

config_id Data type and length
configuration ID of pre-calculated benchmark (tracking ID for pre-calculated benchmark).

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

	[
	    {
	        "config_id": "Sample Return"
	    },
	    ...
	]


Get Benchmark Calculated List

GET /app/api/benchmark/calculated/list?[account_id=:account_id][&max_records=:max_records][&start_record=:start_record]

Returns list of pre-calculated benchmarks for given account. List of pre-calculated benchmarks is sorted by date and time of calculation, the latest records first.

HTTP GET Parameters

account_id Data type and Length
[optional] the PK3 account ID. If not specified, the API caller account is assumed.
max_records Data type and Length
[optional] the maximum number of records returned per request. By default, the maximum number of records is set to 100. You cannot return more than 1000 records per request.
start_record Data type and Length
[optional] index of the first record. By default, index of the first record is 0.

Response: JSON Array

total_record_number Data type and Length
total number of pre-calculated benchmark records found that match the filters.
results JSON array of pre-calculated benchmark records:
     - config_id Data type and Length
configuration ID of pre-calculated benchmark.
     - benchmark_id Data type and Length
benchmark ID.
     - assessment_id Data type and Length
assessment ID. The benchmark was applied to test results of the given assessment.
     - tag_list Data type and Length
list of tags that was used to filter assessment test results dataset.
     - created_on Data type and Length
[yyyy-mm-dd hh:mm:ss] date and time when the calculation was carried out.
     - created_by Data type and Length
ID of the user that initiated the calculation (‘API’ for benchmarks precalculated via API call).

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

	    {
	      "total_record_number": "Sample Return",
	      "results = [
	      	{
	      	  "config_id": "Sample Return", 
	      	  "benchmark_id": "Sample Return",
	      	  "assessment_id": "Sample Return",
	      	  "tag_list = ["Sample Return"],
	      	  "created_on": "Sample Return",
	      	  "create_by": "Sample Return"
	      	},
	      	...
	      	]
	    }


Get Benchmark Calculated Result

GET /app/api/benchmark/calculated/results/:config_id?[max_records=:max_records][&start_record=:start_record][&tags=:tags]

Returns user results for given pre-calculated benchmark. User benchmark result records are sorted by benchmark criteria total match count, the records with highest match count first.

HTTP URL Parameters

config_id Data type and Length
configuration ID of pre-calculated benchmark (pre-calculated benchmark tracking ID).

HTTP GET Parameters

max_records Data type and Length
[optional] the maximum number of user benchmark result records returned per request. By default, the maximum number of records is set to 100. You cannot return more than 1000 status records per request.
start_record Data type and Length
[optional] index of the first record. By default, index of the first record is 0.
tags JSON array
[optional]
{
    tag_list = [...]
}
tag_list Data type and Length
list of tags to apply as a filter. Filters user benchmark results, returns the results for users associated with at least one of the listed tags.

Response: JSON Array

total_record_number Data type and Length
total number of pre-calculated benchmark records found that match the filters.
results JSON array of pre-calculated benchmark records:
     - id Data type and Length
user benchmark result ID.
     - user_ id Data type and Length
PK3 identifier of the user that took the assessment (left empty for external users).
     - user_external_id Data type and Length
for external users, client-side identifier of the user that took the assessment (left empty for PK3 users).
     - tag_list Data type and Length
list of tags associated with the user.
     - disc24_match Data type and Length
“DISC 24” benchmark criteria match count.
     - teams_match Data type and Length
“TEAMS” benchmark criteria match count.
     - values_match Data type and Length
“VALUES” benchmark criteria match count.
     - total_match Data type and Length
benchmark criteria total match count.
     - date_completed Data type and Length
[yyyy-mm-dd hh:mm:ss] assessment completion timestamp.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

	    {
	      "total_record_number": "Sample Return",
	      "results = [
	      	{
	      	  "id": "Sample Return", 
	      	  "user_id": "Sample Return",
	      	  "user_external_id": "Sample Return",
	      	  "user_name": "Sample Return",
	      	  "tag_list = ["Sample Return"],
	      	  "disc24_match": "Sample Return",
	      	  "teams_match": "Sample Return",
	      	  "values_match": "Sample Return",
	      	  "total_match": "Sample Return",
	      	  "date_completed": "Sample Return"
	      	},
	      	...
	      	]
	    }


Get Benchmark Calculated Report: Simple

GET /app/api/benchmark/calculated/report/simple/:benchmark_result_id

Downloads simple PDF report on user benchmark result for pre-calculated benchmark.

HTTP URL Parameters

benchmark_result_id int (12)
user benchmark result ID.

Response: Binary Stream

Binary stream for PDF report. Content-Type: application/pdf. Content-Disposition: attachment.

Get Benchmark Calculated Report: Simple

GET /app/api/benchmark/calculated/report/full/:benchmark_result_id

Downloads full PDF report on user benchmark result for pre-calculated benchmark.

HTTP URL Parameters

benchmark_result_id int (12)
user benchmark result ID.

Response: Binary Stream

Binary stream for PDF report. Content-Type: application/pdf. Content-Disposition: attachment.

Get Benchmark Match Scores

GET /app/api/benchmark/apply/:benchmark_id/:result_id

Returns benchmark match scores for given benchmark applied to specified completed assessment test.

HTTP URL Parameters

benchmark_id int (12)
assessment result ID.
result_id int (12)
assessment result ID.

Response: JSON array

disc24_match Data type and length
“DISC 24” benchmark criteria match count.
teams_match Data type and length
“TEAMS” benchmark criteria match count.
values_match Data type and length
“VALUES” benchmark criteria match count.
total_match Data type and length
benchmark criteria total match count.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
      "disc24_match": "Sample Return",
      "teams_match": "Sample Return",
      "values_match": "Sample Return",
      "total_match": "Sample Return"
    }


Get Simple PDF Benchmark Report

GET /app/api/benchmark/apply/report/simple/:benchmark_id/:result_id

Downloads simple PDF report on given benchmark applied to specified completed assessment test.

HTTP URL Parameters

benchmark_id int (12)
assessment result ID.
result_id int (12)
assessment result ID.

Response: Binary Stream

Binary stream for PDF report. Content-Type: application/pdf. Content-Disposition: attachment.

Get Full PDF Benchmark Report

GET /app/api/benchmark/apply/report/full/:benchmark_id/:result_id

Downloads full PDF report on given benchmark applied to specified completed assessment test.

HTTP URL Parameters

benchmark_id int (12)
assessment result ID.
result_id int (12)
assessment result ID.

Response: Binary Stream

Binary stream for PDF report. Content-Type: application/pdf. Content-Disposition: attachment.