List Transformations
Lists all performed transformations, with either pagination or specific reference IDs.
Authenticate using API Key in request header
In: header
Query Parameters
This specifies a limit on the number of objects to return, ranging between 1 and 100.
501 <= value <= 100Specifies sorting behavior. The two options are asc and desc to sort ascending and descending respectively, with default sort being ascending. Paging works in both directions.
"asc""asc" | "desc"A cursor to use in pagination. startingAfter is a transform ID that defines your place in the list. For example, if you make a list request and receive 50 objects, ending with tr_2bxoJPNdSD4LgRT4YVC4gt72hlI, your subsequent call can include startingAfter=tr_2bxoJPNdSD4LgRT4YVC4gt72hlI to fetch the next page of the list.
A cursor to use in pagination. endingBefore is a transform ID that defines your place in the list. For example, if you make a list request and receive 50 objects, starting with tr_2bxoJPNdSD4LgRT4YVC4gt72hlI, your subsequent call can include endingBefore=tr_2bxoJPNdSD4LgRT4YVC4gt72hlI to fetch the previous page of the list.
The unique ID for a given pipeline. Will filter to just the transformations processed by the given pipeline. If left out, will query over ALL transformations for your account.
Array with the reference IDs of the transformed data points. Formatted as a CSV array.
Array with the transform IDs of the transformed data points. Formatted as a CSV array.
Array with the function IDs to filter transformations by. Formatted as a CSV array.
Array with the function names to filter transformations by. Formatted as a CSV array.
Array with the event IDs to filter transformations by. Formatted as a CSV array.
Array with task IDs to filter transformation by. Formatted as a CSV array.
Boolean that toggles filtering whether or not transformations were successfully published via webhook.
Filters to transformations successfully published via webhook before the specified date. Must be in RFC 3339 format.
date-timeFilters to transformations successfully published via webhook after the specified date. Must be in RFC 3339 format.
date-timeFilters based on the index of the page of the document you had transformed. For CSV transformations, this offset represents starting row of the CSV for which you want to fetch transformations for. For PDF transformations, this offset represents the starting page of the PDF. This applies for a specific reference ID of a transformation. Note that this only applies if you specify one reference ID in referenceIDs and if you have independentDocumentProcessingEnabled set to true in your pipeline configuration. Note that this is zero-indexed.
0 <= valueResponse Body
curl -X GET "https://api.bem.ai/v1-beta/transformations?limit=50&sortOrder=asc&startingAfter=string&endingBefore=string&pipelineID=string&referenceIDs=string&transformationIDs=string&functionIDs=string&functionNames=string&eventIDs=string&taskIDs=string&published=true&publishedBefore=2019-08-24T14%3A15%3A22Z&publishedAfter=2019-08-24T14%3A15%3A22Z&itemOffset=0"{
"totalCount": 0,
"transformations": [
{
"transformationID": "tr_2bxoJPNdSD4LgRT4YVC4gt72hlI",
"pipelineID": "pl_2bxoUSASD7LPqz4YVC9jt38ZtZ",
"referenceID": "2bkFKzUi2ZNLae0E06vgo37zH2v",
"createdAt": "2023-08-13T16:07:54+08:00",
"publishedAt": "2023-08-13T16:10:00+08:00\"",
"lastPublishErrorAt": {},
"inputType": "email",
"itemOffset": 0,
"transformedContent": {
"output": [
{}
]
},
"invalidProperties": [
"string"
],
"eventID": "evt_2bxoJPNdSD4LgRT4YVC4gt72hlI",
"functionID": "f_2bxoUSASD7LPqz4YVC9jt38ZtZ",
"functionName": "transform_invoice",
"taskID": "string"
}
]
}