Review a report
Acts on a report in needs_review, which is held back because the resume does not look like it fits the job. proceed runs the full analysis anyway, as Proceed anyway does in the app, and is charged like a new report. dismiss accepts the report as it stands: it completes with its cautious score and no further analysis.
Required scope: reports:write.
Errors
- 400:
invalid_content_type,invalid_idempotency_key,invalid_json,request_body_too_large,unknown_field - 401:
authentication_required,invalid_api_key - 402:
insufficient_credits,price_exceeds_max,quota_exceeded - 403:
api_access_disabled,insufficient_scope - 404:
report_not_found - 409:
idempotency_key_reused,idempotency_request_in_progress,job_closed,report_not_reviewable - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>id*stringThe report's ID.
1 <= length <= 200Idempotency-Key?stringMakes retries safe. Repeating a request with the same key and body within 24 hours returns the original response with Idempotent-Replayed: true. The same key with a different body, or from a different API key, returns idempotency_key_reused.
1 <= length <= 255application/json- body
action*stringproceed runs the full analysis despite the mismatch and is charged like a new report. dismiss accepts the report as it stands and completes it.
"proceed""dismiss"maxCredits?numberWith proceed, the most credits you allow the rerun to cost. See maxCredits on POST /v1/reports.
0 < value <= 1000000Success.
application/json- response
object*stringid*stringThe report's ID. The same ID the app uses.
externalId*|Your own ID for the report, unique within the organization.
status*stringqueued while it waits for the resume to be read or for capacity, processing while it is analysed, needs_review when a person must decide, completed and failed.
"queued""processing""needs_review""completed""failed"failureCode*|Why the report failed, when status is failed.
candidate*|The candidate analysed. Null if the candidate was deleted.
job*|The job analysed against. Null if the job was deleted.
score*|Resume fit: how well the resume fits the job, 0 to 10.
summary*|A short assessment of the fit.
decision*|The current hiring decision for this candidate and job.
interview*|The latest interview for this report.
reportVersion*|The report version that analysed the resume. Null until the analysis starts.
createdAt*stringWhen the report was created.
date-timeupdatedAt*stringWhen the report last changed.
date-timecompletedAt*|When the analysis finished.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.# Idempotency-Key is optional. Reuse the same key and body when retrying one logical write.curl --fail-with-body -X POST "$PROBB_URL/api/v1/reports/ID_VALUE/review" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H "Idempotency-Key: $REQUEST_KEY" \ -H 'Content-Type: application/json' \ --data-binary '{ "action": "proceed", "maxCredits": 5}'{ "object": "report", "id": "string", "externalId": "string", "status": "queued", "failureCode": "analysis_failed", "candidate": { "id": "string", "name": "string" }, "job": { "id": "string", "title": "string" }, "score": 0, "summary": "string", "decision": "advance", "interview": { "id": "string", "status": "invited" }, "reportVersion": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z"}