Get Relationship Insights Job Status

Output representation that contains information about the relationship insight generation job and links to related resources.

JSON Example

Sample response when status is in IN_PROGRESS.

1{
2  "jobId": "JOB-LEAD-9f31c",
3  "status": "IN_PROGRESS",
4  "createdDate": "2026-01-16T01:15:00.000Z",
5  "lastUpdated": "2026-01-16T01:18:30.000Z",
6  "target": { "targetRecordObject": "Opportunity", "targetRecordId": "006xx0000001234AAA" },
7  "useCaseApiName": "RRA_Default",
8  "regenerationMode": "REFRESH_IF_EXPIRED",
9  "progress": { "stage": "collecting_sources", "percentComplete": 35 },
10  "result": { "insightId": null },
11  "error": null,
12  "links": {
13    "self": "/services/data/vXX.X/connect/rra/relationship-insights/jobs/JOB-LEAD-9f31c",
14    "insight": null
15  }
16}

Sample resonse when status is COMPLETED.

1{
2  "jobId": "JOB-LEAD-9f31c",
3  "status": "COMPLETED",
4  "createdDate": "2026-01-16T01:15:00.000Z",
5  "lastUpdated": "2026-01-16T01:22:10.000Z",
6  "target": { "targetRecordObject": "Opportunity", "targetRecordId": "006xx0000001234AAA" },
7  "useCaseApiName": "RRA_Default",
8  "regenerationMode": "REFRESH_IF_EXPIRED",
9  "progress": { "stage": "persisted", "percentComplete": 100 },
10  "result": { "insightId": "rra-insight-000456" },
11  "error": null,
12  "links": {
13    "self": "/services/data/vXX.X/connect/rra/relationship-insights/jobs/JOB-LEAD-9f31c",
14    "insight": "/services/data/vXX.X/connect/rra/relationship-insights/rra-insight-000456"
15  }
16}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`createdDate`	String	Date and time when the job was created.	Big, 67.0	67.0
`diagnosticDetails`	String	Additional diagnostic information for administrators and support tooling. Includes information such as error details, processing stage, and trace token. Returned only when `includeDiagnostics` is true.	Big, 67.0	67.0
`error`	RRA Job Error[]	Error information for the job, when available.	Big, 67.0	67.0
`insightId`	String	Identifier of the relationship insight record associated with the request, if available at the time of the response. This value can be null if the request is queued.	Big, 67.0	67.0
`jobId`	String	Identifier for the asynchronous request to track status and support logging and observability.	Big, 67.0	67.0
`lastUpdated`	String	Timestamp of the most recent status or insight update for this request.	Big, 67.0	67.0
`links`	RRA Job Links[]	Optional hypermedia links to related resources, such as insight retrieval or request status APIs.	Big, 67.0	67.0
`progress`	RRA Job Progress[]	Progress information for the relationship insight generation job.	Big, 67.0	67.0
`regenerationMode`	String	Regeneration mode applied to the request.	Big, 67.0	67.0
`result`	RRA Job Result[]	Information about the generated relationship insight after job completes.	Big, 67.0	67.0
`status`	String	Current status of the relationship insight generation job. Possible values include QUEUED, IN_PROGRESS, COMPLETED, FAILED, and ALREADY_IN_PROGRESS.	Big, 67.0	67.0
`target`	RRA Insight Target[]	Target record metadata for the insight.	Big, 67.0	67.0
`useCaseApiId`	String	ID of the relationship research insight use case applied during insight generation.	Big, 67.0	67.0
`useCaseApiName`	String	Name of the relationship research insight use case applied during insight generation.	Big, 67.0	67.0