POST /analytics

Creates a graph to directly compare behavioral assessment patterns of a group individuals

Request

POST https://pi.predictiveindex.com/api/v1/analytics?format=<image format>

Path Parameters

N/A

Query Parameters

ParameterTypeValueRequiredNotes
formatstringThe format of the file returnedRequiredValid values:

PNG

SVG

languageLocalestringThe language for the outputOptionalThe default value is en-US (English) if no value is provided.

A list of valid values is available on the Commonpage.

Request Body

ParameterTypeValueRequiredNotes
assessmentUserIdsarrayYes
positionId string
NoThis is required if showJobPatternOverlay = true 
factorToRetrivestringYesValid values are:

FactorA

FactorB

FactorC

FactorD

FactorCombination

AllFactorEnsemble
presentationUnitsstringYesValid values are: 

UnitsN

Percentage

showAveragePatternbooleanNo
showJobPatternOverlaybooleanNo
showLegendbooleanNo
viewTypestringNoValid values are:

Trend

Individual

Response

If successful, this method returns a 200 OK response code and the response image body.

Response Body

Response image in the requested format.

Example Request

curl -X POST https://pi.predictiveindex.com/api/v1/analytics?format=PNG&languageLocale=en-US \

   -H "api-key: 12345678-ABCD-EFGH-1234-ABCDEFGH1234" \

   -H "Content-Type: application/json" -d @body.json

Example Request Body (@body.json)

{

  "assessmentUserIds": ["abcd6001-9t12-4d48-87dd-bb8ef85y3q94","abcd6001-9t12-4d48-87dd-bb8ef85y3q95"],

  "positionId": "abcd6001-9t12-4d48-87dd-bb8ef85y3q96",

  "factorToRetrieve": "FactorA",

  "presentationUnits": "UnitsN",

  "showAveragePattern": true,

  "showJobPatternOverlay": true,

  "showLegend": true,

  "viewType": "Trend"

}

Example Response

/developers/s/analytics_response.png?v=1