Retrieve a specific report generation information

Retrieve detailed information about a specific report generation task by its ID.

GET /billing/org/v1/reports/{id}

Retrieve a specific report generation information

cURL

curl --request GET \
  --url https://api.gcore.com/billing/org/v1/reports/{id} \
  --header 'Authorization: <api-key>'

200

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": 123,
  "client_id": 123,
  "status": "Pending",
  "processing_notes": {
    "celery_group_id": "<string>",
    "period": "<string>",
    "records_to_process": 123,
    "errors": [
      {}
    ],
    "warnings": [
      {}
    ]
  },
  "parameters": {
    "type": "<string>",
    "date_from": "2023-12-25",
    "date_to": "2023-12-25",
    "client_id": 123
  }
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

id · string<uuid> · required

Response

200

application/json

Request successful.

uuid · string<uuid> · required · read-only

created_at · string<date-time> · required · read-only

Task creation time

updated_at · string<date-time> · required · read-only

Task update time

user_id · integer · required · read-only

client_id · integer · required · read-only

task_type · enum<string> · required · read-only

• ClosingPeriod - closing_period
• ImportData - import_data
• Report - report
• StopSubscriptions - stop_subscriptions

Available options: ClosingPeriod, ImportData, Report, StopSubscriptions

status · enum<string> · default: Pending · required · read-only

• Pending - pending
• InProgress - in_progress
• Completed - completed
• Failed - failed
• Cancelled - cancelled

Available options: Pending, InProgress, Completed, Failed, Cancelled

processing_notes · Processing notes · object · required · read-only

Processing notes. Contains additional information about the task processing.

Show child attributes

parameters · Task parameters · object

Parameters for the task. The structure depends on the task type. For report tasks, see available templates and their parameters at the reports templates operation.

Show child attributes