Skip to main content
GET
/
reports
/
transfers
List transfer reports
curl --request GET \
  --url https://api.prequel.co/reports/transfers \
  --header 'X-API-KEY: <api-key>'
{
  "status": "<string>",
  "data": {
    "transfer": {
      "id": "<string>",
      "is_full_refresh": true,
      "models": [
        "<string>"
      ],
      "log": "<string>",
      "submitted_at": "2023-11-07T05:31:56Z",
      "start_transfer_window_at": "2023-11-07T05:31:56Z",
      "end_transfer_window_at": "2023-11-07T05:31:56Z",
      "rows_transferred": 123,
      "delta_rows_transferred": 123,
      "volume_transferred_in_mb": 123,
      "actor_id": "<string>",
      "source_ids": [
        "<string>"
      ],
      "destination_id": "<string>",
      "model_metrics": [
        {
          "model_id": "<string>",
          "rows_transferred": 123,
          "delta_rows_transferred": 123,
          "volume_transferred_in_mb": 123,
          "start_transfer_window_at": "2023-11-07T05:31:56Z",
          "end_transfer_window_at": "2023-11-07T05:31:56Z",
          "most_recent_last_updated_at": "2023-11-07T05:31:56Z",
          "error": {
            "error": "<unknown>",
            "error_code": "<string>",
            "title": "<string>",
            "blame": "<string>",
            "documentation_url": "<string>",
            "trace": "<string>",
            "message": "<string>"
          },
          "model_name": "<string>"
        }
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "tags": {}
    }
  },
  "message": "<string>",
  "has_next": true,
  "next_url": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
destinations
string

Destination ID (or comma-separated list of destination IDs).

​
start
string

Start date of report (in the format YYYY-MM-DD).

​
end
string

End date of report (in the format YYYY-MM-DD).

​
page_size
integer

Number of items to return per page.

​
order
enum<string>

Sort order for items

Available options:
asc,
desc
​
cursor
string

Used for pagination - represents last page seen. Value is included in response when there is a next page.

Response

OK

​
status
string
required
Allowed value: "success"
​
data
object
required
​
message
string
required
​
has_next
boolean
required

Whether there are more items beyond this page.

​
next_url
string

Full URL to fetch the next page. Only present when has_next is true.