Accounts and SettingsProcess

Get process details

Retrieves detailed information about a specific background process. **Use this to:** - Get detailed status of a specific process - Monitor process progress and completion - Download results from completed export processes - Check error details for failed processes - Track process execution times **Key information returned:** - Complete process details and status - Import/export statistics and results - Error information for troubleshooting - Download URLs for export processes - Process timing and performance data **Important considerations:** - Process ID must exist in your account - Completed processes provide detailed statistics and results - Export processes include download URLs when successful - Failed processes contain error messages for debugging - Timing information helps with performance analysis - Different process types return different result structures

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

processIdlongRequired
Id of the process

Response

Process information retrieved successfully
idlong
Unique identifier of the process
nameenum

Name/type of the process

statusenum
Current status of the process
Allowed values:
infoobject or null

Additional process information (for completed processes)

export_urlstring or nullformat: "url"
Download URL for completed export processes
errorstring or null
Error message for failed processes
created_atdatetime or null
Process creation timestamp
completed_atdatetime or null
Process completion timestamp

Errors