Returns a PNG image or base64-encoded PNG of the primary chart in the report for a completed assessment compared to a job. Base64 is useful for embedding charts in email messages, embedding charts directly in HTML pages without additional storage, or storage images in JSON or XML format.

See the GetReportForJob method to request a complete report.

Parameter Value
Required. 1-50 characters. Case-sensitive. Visit Settings | API:Security to change your API token (Berke login required). Your API token is a server-side authentication value. Do not embed it in client-side Javascript or submit it to Berke via an insecure connection.
Optional. Null or 1-50 characters. Your API Token is mapped to a default user. Use this field to change from the default API user to a specific user. The user must exist in your Berke account and is active. Null defaults to default API user. Visit Settings | API:Security to change your default API user (Berke login required).
Required. 1-50 characters. Not case-sensitive. Source identifier of the participant to update. Existing SourceCandidateId values can be seen and/or modified in the Berke Assessment site by clicking the Optional Settings button on the Update Assessment User page.
Optional. 0-50 characters. If null, the assessment's primary job will be selected. If provided, SourceJobId must be assigned to a Berke job via the Settings link's API | Job Assignments (Berke login required) option. You can retrieve your sourceJobId values with the GetJobs method.
Optional. Null or 0 to 3. Null and 0 select the default report for the audience, 1 selects [Job Fit Report], 2 selects [Spotlight Report], and 3 selects [Participant Report].
Optional. Null or 0 or 1. Null defaults to Image/PNG, 0 = Image/PNG and 1 = Plain/Text base64-encoded PNG
Successful Example Response
Success [200] Successful responses return a PNG image (image/png) or a base64-encoded string (text/plain) according to the outputFormat parameter value.
Status Code Failed Example Responses
The assessment you requested has been deleted or inactivated.
The job you requested has been deleted or inactivated.
The assessment you requested is not complete.
The SourceJobId you passed in was not found. Visit your Job Assignments (Berke login required) to correct.
The SourceCandidateId value you passed in was not found.
There was not enough assessment data captured for the SourceCandidateId to create a report using the requested SourceJobId.
Department (sourceDepartmentId) to which this assessment is assigned is not enabled. Assessments in disabled departments cannot be created, modified, or accessed via the API.
OutputFormat must be null (default = PDF), 0 (PDF) or 1 (HTML).
Null and 0 select the default report for the audience, 1 selects [Job Fit Report], 2 selects [Spotlight Report], and 3 selects [Participant Report].
Most API exceptions are due to invalid parameters. Review the notes below each parameter as well as the output and HTTP response code from the error message. If all values are appropriate, the failure is likely authentication-related. Authentication failure types include, but are not limited to,:
  • Too many failed calls
  • Maximum per minute or per day API calls reached
  • API call made via insecure connection
  • Invalid API key
  • API is not enabled for target company
  • API is disabled for all companies (typically during maintenance)
  • Company is inactive or expired
  • Invalid username
  • User is inactive or expired
  • Unknown sourceJobId - check your API job assignments in the primary Berke customer site
  • Invalid assessment complete action

        

            
<?xml version="1.0" encoding="utf-16"?>
<berkeResponse status="[!=ok]" response="[API Method] API method requests exceeded burst limit of 120 occurrences within 60000 milliseconds. Excess requests occurred 3 times from [2024-11-22T08:57:05.1683946Z] to [2024-11-22T08:57:05.7683946Z]." responseCode="429" callDeniedDateTime="2024-11-22T08:57:05.8683946Z" callExpiresOnCompletion="true" countCallsExceeded="3" estimatedMillisecondsToNextAllowedCall="423" firstCallDeniedDateTime="2024-11-22T08:57:05.5683946Z" isDailyLimit="false" maximumCallsPerTimeFrame="120" timeFrameMilliseconds="60000" />

            
{
  "callDeniedDateTime": "2024-11-22T08:57:05.8683946Z",
  "callExpiresOnCompletion": true,
  "countCallsExceeded": 3,
  "estimatedMillisecondsToNextAllowedCall": 423,
  "firstCallDeniedDateTime": "2024-11-22T08:57:05.5683946Z",
  "isDailyLimit": false,
  "maximumCallsPerTimeFrame": 120,
  "timeFrameMilliseconds": 60000,
  "status": "[!=ok]",
  "response": "[API Method] API method requests exceeded burst limit of 120 occurrences within 60000 milliseconds. Excess requests occurred 3 times from [2024-11-22T08:57:05.1683946Z] to [2024-11-22T08:57:05.7683946Z].",
  "responseCode": "429"
}

        


        

            API requests exceeded the maximum allowed per time-frame or the maximum allowed at any point in time.
        

        

                

                    
                        API throttle limits are set per-company. Please login and return to this area to see
                        your company's specific throttle configuration.
                    
                

                

        Your application can use the following API method response information to determine its course of action when HTTP status code 429
        is returned by an API method call:
    

    
    
        
  • 
            callDeniedDateTime: The date and time that the API method call was denied execution.
        
    • 
        
  • 
            callExpiresUponCompletion: If this value is true then too many simultaneous calls occurred to a particular group of API methods.
            If this value is false then too many requests occurred for a particular time frame (daily or short-term).
        
    • 
        
  • 
            countCallsExceeded: The count of calls that exceeded the maximum number of allowed API calls for the time frame.
        
    • 
        
  • 
            estimatedMillisecondsToNextAllowedCall: The estimated number of milliseconds, from the callDeniedDateTime, before an API
            call will be allowed to execute. If callExpiresUponCompletion is true then this value will be zero as the time is dependent on
            numerous factors.
            If callExpiresUponCompletion is false then this value indicates the amount of time your application(s) should wait before
            attempting to make the same API method call. If a daily API call limit has been exceeded the this value indicates the amount of time
            your application(s) should wait before calling any API method.
        
    • 
        
  • 
            firstCallDeniedDateTime: The date and time that the first call, of potentially many calls, was denied for the time frame.
            For example, if an application was denied ten calls within a time frame then firstCallDeniedDateTime
            indicates date and time that the first of the ten calls was denied.
        
    • 
        
  • 
            isDailyLimit: If this value is true then the response indicates that the maximum number of API methods calls for the current day has been exceeded. If this
            value is false then the response indicates that the maximum number of API method calls for a time frame, other than daily, has been exceeded.
        
    • 
        
  • 
            maximumCallsPerTimeFrame: Indicates the maximum number of times an API method can be called for daily, short-term or simultaneous call limits.
        
    • 
        
  • 
            timeFrameMilliseconds: Indicates the number of milliseconds in which maximumCallsPerTimeFrame API method calls is allowed.
        
    • 
    


        

    		

    

        
            Other Failure Types [!=200]
        
        
                

        
    
            
  • Too many failed calls
    • 
            
  • Maximum per minute or per day API calls reached
    • 
            
  • API call made via insecure connection 
    • 
            
  • Invalid API key 
    • 
            
  • API is not enabled for target company 
    • 
            
  • API is disabled for all companies (typically during maintenance) 
    • 
            
  • Company is inactive or expired 
    •