FTP Submissions

List All FTP File Submissions

get

Returns a list of your FTP file submissions, which can be filtered by submission or completion date.

Path parameters

AccountSIDstringRequired

Query parameters

SubmissionDateStartstring · date-timeOptional

Return submissions submitted after this date (ISO 8601).

SubmissionDateEndstring · date-timeOptional

Return submissions submitted before this date (ISO 8601).

CompletedDateStartstring · date-timeOptional

Return submissions completed after this date (ISO 8601).

CompletedDateEndstring · date-timeOptional

Return submissions completed before this date (ISO 8601).

Responses

200

A paginated list of FTP submission objects.

application/json

get/Advertisers/{AccountSID}/FTPFileSubmissions

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/FTPFileSubmissions HTTP/1.1
Host: api.impact.com
Accept: */*

200

A paginated list of FTP submission objects.

{
  "FTPFileSubmissions": [
    {
      "BatchId": "BATCH-789",
      "AccountId": 12345,
      "SubmissionDate": "2026-09-10T22:55:32-08:00",
      "FileName": "actions_20260910.csv",
      "Type": "Conversion",
      "Status": "Queued",
      "TotalRecords": 1000,
      "TotalErrors": 5,
      "CompletionDate": "2026-09-10T22:55:45-08:00",
      "ErrorsUri": "/Advertisers/<AccountSID>/FTPSubmissions/BATCH-789/Errors",
      "Uri": "/Advertisers/<AccountSID>/FTPSubmissions/BATCH-789"
    }
  ]
}

Get FTP Submission Details

get

Retrieves information about records submitted in a specific FTP batch file.

Path parameters

AccountSIDstringRequired

BatchIdstringRequired

The unique batch ID of the FTP submission.

Responses

200

A single FTP submission object.

application/json

BatchIdstringOptional

Id of the FTP submission.

Example: BATCH-789

AccountIdintegerOptional

Id of the brand account that submitted the file.

Example: 12345

SubmissionDatestring · date-timeOptional

Date and time the FTP submission was submitted (ISO 8601).

Example: 2026-09-10T22:55:32-08:00

FileNamestringOptional

Name of the file that was submitted.

Example: actions_20260910.csv

Typestring · enumOptional

Type of records submitted.

Possible values:

Statusstring · enumOptional

Status of the FTP submission. Will always begin as Queued.

Possible values:

TotalRecordsintegerOptional

Total number of records in the submitted file.

Example: 1000

TotalErrorsintegerOptional

Total number of errors found in the submitted file.

Example: 5

CompletionDatestring · date-time · nullableOptional

Date and time that the submission finished processing (ISO 8601). Empty if not finished.

Example: 2026-09-10T22:55:45-08:00

ErrorsUristring · uri-referenceOptional

The URI to retrieve detailed error information for this submission.

Example: /Advertisers/<AccountSID>/FTPSubmissions/BATCH-789/Errors

Uristring · uri-referenceOptional

The unique reference to this FTP submission in the impact.com API.

Example: /Advertisers/<AccountSID>/FTPSubmissions/BATCH-789

get/Advertisers/{AccountSID}/FTPFileSubmissions/{BatchId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/FTPFileSubmissions/{BatchId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

A single FTP submission object.

{
  "BatchId": "BATCH-789",
  "AccountId": 12345,
  "SubmissionDate": "2026-09-10T22:55:32-08:00",
  "FileName": "actions_20260910.csv",
  "Type": "Conversion",
  "Status": "Queued",
  "TotalRecords": 1000,
  "TotalErrors": 5,
  "CompletionDate": "2026-09-10T22:55:45-08:00",
  "ErrorsUri": "/Advertisers/<AccountSID>/FTPSubmissions/BATCH-789/Errors",
  "Uri": "/Advertisers/<AccountSID>/FTPSubmissions/BATCH-789"
}

Get FTP Submission Error Details

get

Returns a list of all errors that exist within a specific FTP file submission.

Path parameters

AccountSIDstringRequired

BatchIdstringRequired

The unique batch ID of the FTP submission.

Responses

200

A paginated list of FTP submission error objects.

application/json

get/Advertisers/{AccountSID}/FTPFileSubmissions/{BatchId}/ErrorDetails

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/FTPFileSubmissions/{BatchId}/ErrorDetails HTTP/1.1
Host: api.impact.com
Accept: */*

200

A paginated list of FTP submission error objects.

{
  "ErrorDetail": [
    {
      "Line": 42,
      "CampaignId": 1000,
      "ActionTrackerId": 18500,
      "MediaPartnerId": 2552842,
      "EventCode": "",
      "OrderId": "9217374917471",
      "Category": "VALIDATION",
      "Sku": "ACME-TENNIS-101",
      "Status": "Validation",
      "Reason": "Invalid date format",
      "Uri": "/Advertisers/<AccountSID>/FTPSubmissions/BATCH-789/Errors/42"
    }
  ]
}