Data Lake Delta Files API
| Action | Endpoint |
|---|---|
| Fetch Delta Files | POST/business-stats/delta-files/list |
| Fetch Delta File | POST/business-stats/delta-files/download |
Delta File Endpoints
Fetch List of Delta Files
Fetch List of Delta Files
fetchDeltaFilesPOST
/business-stats/delta-files/listFetch Specific Delta File
Fetch Specific Delta File
fetchDeltaFilePOST
/business-stats/delta-files/downloadRequest:
DeltaFileDownloadRequestResponse:
StreamingResponseBody<string>Security Group:
delta-filesPermission:
readDelta File Request and Response Objects
DeltaFilesGetRequest
Required properties
| Property | Type | Description |
|---|---|---|
tenantLocator | uuid | Locator of the tenant corresponding to the data |
transformationTable | Enum DataLakeAccountDataExtensions | DataLakeAccounts | DataLakeAffectedTransactions | DataLakeAuxData | DataLakeBillingHolds | DataLakeClaimDataExtensions | DataLakeClaims | DataLakeCreditDistributions | DataLakeCreditItems | DataLakeDelinquencies | DataLakeDelinquencyReferences | DataLakeDiaries | DataLakeDisbursementDataExtensions | DataLakeDisbursements | DataLakeFaTransactionAccountLines | DataLakeFaTransactions | DataLakeFnolDataExtensions | DataLakeFnols | DataLakeInstallmentItems | DataLakeInstallments | DataLakeInstallmentSettings | DataLakeInvoiceItems | DataLakeInvoices | DataLakeLedgerAccountLineItems | DataLakeLedgerAccounts | DataLakeMoratoriumElections | DataLakeMoratoriums | DataLakeMoratoriumStatuses | DataLakePaymentDataExtensions | DataLakePayments | DataLakePolicies | DataLakePolicyAutoRenewals | DataLakePolicyCoverageTerms | DataLakePolicyDataExtensions | DataLakePolicyElementCharges | DataLakePolicyElements | DataLakePolicyElementTree | DataLakePolicyElementUnderwritingFlags | DataLakePolicyPreferences | DataLakePolicySegments | DataLakePolicyStatuses | DataLakePolicyTerms | DataLakePolicyTransactionChangeInstructions | DataLakePolicyTransactions | DataLakeProducerCodeDataExtensions | DataLakeProducerCodes | DataLakeProducerDataExtensions | DataLakeProducerHierarchy | DataLakeProducers | DataLakeQuoteCoverageTerms | DataLakeQuoteDataExtensions | DataLakeQuoteElementCharges | DataLakeQuoteElements | DataLakeQuoteElementTree | DataLakeQuoteElementUnderwritingFlags | DataLakeQuotes | DataLakeTaskReferences | DataLakeTasks | DataLakeUserAssociations | DataLakeUserQualifications | DataLakeWriteOffs | Name of the desired Data Lake table |
Optional properties
| Property | Type | Description |
|---|---|---|
startTime | integer? | Files in returned index will all have a generationTime later than startTime. Format is UNIX timestamp in UTC milliseconds (e.g. 1741713134934) |
dataProcessedThroughTime | integer? | Only files with a dataProcessedThroughTime prior to or equal to this time will be returned. Format is UNIX timestamp in UTC seconds (e.g. 1451606100) |
deltaFileType | Enum? sql | csv | The format of the delta files to be returned. Defaults to sql if omitted |
lastFile | string? | Only files after this file in the index will be returned. Must provide full fileName |
version | integer? | Target a specific schema version; defaults to latest if omitted |
DeltaFilesGetResponse
Required properties
| Property | Type | Description |
|---|---|---|
createTableFile | string | Path & name of file with necessary sql statement to create the table in the destination schema |
dataProcessedThroughTime | integer | The time of the latest operational change that will be reflected in the data. Format is UNIX timestamp in UTC seconds (e.g. 1451606100) |
dropTableFile | string | Path & name of file with necessary sql statement to drop the existing version of the table in the destination schema |
s3Bucket | string | The source S3 bucket required for the DeltaFileDownloadRequest |
version | integer | Target a specific schema version; defaults to latest if omitted |
deltaFiles | DeltaFile[] | The index of individual delta files |
DeltaFile
Required properties
| Property | Type | Description |
|---|---|---|
fileName | string | The name of the delta file |
deltaFileType | Enum sql | csv | The format of the delta file |
generationTime | integer | The time that the file was generated. Format is UNIX timestamp in UTC milliseconds (e.g. 1741713134934) |
jobEndTime | integer | The that the job to generate the file ended. Format is UNIX timestamp in UTC seconds (e.g. 1451606100) |
jobStartTime | integer | The that the job to generate the file began. Format is UNIX timestamp in UTC seconds (e.g. 1451606100) |
Optional properties
| Property | Type | Description |
|---|---|---|
md5HashSum | string? | For files with deltaFileType = csv, the MD5 format hashsum for the file contents, including headers |
recordCount | integer? | For files with deltaFileType = csv, the number of rows in the file, excluding headers |
DeltaFileDownloadRequest
Required properties
| Property | Type | Description |
|---|---|---|
tenantLocator | uuid | Locator of the tenant corresponding to the data |
fileName | string | The name of the file to be requested. Value may be fileName, createTableFile, or dropTableFile |
Optional properties
| Property | Type | Description |
|---|---|---|
s3Bucket | string? | The name of the S3 bucket as returned by the DeltaFilesGetResponse. Only required if requesting createTableFile or dropTableFile, and deltaFileType is csv |