Report status

Provides status of a report job.

Report status

get/services/reports/status

Retrieve status for a specified report job.

SecurityOAuth2
Request
query Parameters
reportId
required
string

Name for the report.

Example: reportId=1
outputType
required
string

Format for the report output.

Enum: "csv" "excel" "fec" "html" "pdf" "text" "zip"
Example: outputType=pdf
outputLocation
required
string

Location where the report output is stored.

Enum: "cloud" "intacct"
Example: outputLocation=intacct
Responses
200

OK

303

See Other

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "reportId": 1,
    • "status": "completed",
    • "outputType": "pdf",
    • "outputLocation": "cloud",
    • "cloudStore": {
      • "target": "s3",
      • "path": "/"
      },
    • "name": "Customer Report",
    • "href": "/services/reports/status?reportId=1&outputType=pdf&outputLocation=cloud"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}