Skip to main content
POST
/
files
/
search
Search across processed files
curl --request POST \
  --url https://api.sftpsync.io/files/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "pipelineRunIds": [
    "<string>"
  ],
  "searchTerm": "<string>",
  "fieldName": "<string>",
  "exactMatch": true,
  "caseSensitive": true,
  "offset": 123,
  "limit": 123
}
'
{
  "results": [
    {
      "pipelineRunId": "<string>",
      "filename": "<string>",
      "rowIndex": 123,
      "rowData": {},
      "matchingFields": [
        "<string>"
      ],
      "processedAt": "2023-11-07T05:31:56Z",
      "pipelineName": "<string>",
      "clientName": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "returned": 123
  },
  "metadata": {
    "searchTerm": "<string>",
    "caseSensitive": true,
    "searchDurationMs": 123,
    "filesSearched": 123
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
pipelineRunIds
string[]
required
Minimum array length: 1
searchTerm
string

Omit to return all rows from the given runs.

fieldName
string
exactMatch
boolean
caseSensitive
boolean
offset
integer
limit
integer

1–1000.

Response

200 - application/json

Search results

results
object[]
required
pagination
object
required
metadata
object
required