Transaction

Varsha Neelesh
Varsha Neelesh
  • Updated

List Transaction

Lists all transactions based on the request parameters. Mandatory parameters are startTime and endTime.

Request Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Query Parameters

 

NameTypeRequiredNotes
endTimestringrequired-table (1).svg

End of the range of records to return

Format: YYYY-MM-ddTHH:mm:ss

startTimestringrequired-table (1).svg

Start of the range of records to return

Format: YYYY-MM-ddTHH:mm:ss

cursorTokenstring 

Use the value from last response to get the next set of records

limitinteger 

Limit the number of the records to be returned

operationstring 

Type of error records to return

Allowed values:

Create|Update|Delete|Disconnect|Merge|Merge_Report_Only
synapseNamestring 

Return only records with this synapse name

syncariEntityNamestring 

Return only records with this syncari entity name

syncariRecordId
 
string 

Return the single record with this record id

Example

Request Sample

curl --request GET --url https://api.syncari.com/api/v1/transactions?startTime=YYYY-MM-ddTHH:mm:ss&endTime=YYYY-MM-ddTHH:mm:ss \
    --header 'Accept: application/json' \
    --header 'Authorization: FTON46895FBIl' \
    --header 'Content-Type: application/json' \
    --header 'clientRequestId: 123456789' \
    --header 'syncariId: VBKIUF' 

Response Sample

{
  "success": true,
  "requestId": "5755792480",
  "timestamp": "2022-10-19T10:37:34.450243Z",
  "cursorToken": "NjJlYTI1OWQ5Y2IxOTZhOWY2YWI4ZGMw",
  "result": [
    {
      "id": "62ea259d9cb196a9f6ab8dc0",
      "createdBy": "62df5d3769da560c679d5056",
      "createdAt": "2022-08-03T07:37:01.203+00:00",
      "updatedBy": "62df5d3769da560c679d5056",
      "updatedAt": "2022-08-03T07:37:14.761+00:00",
      "syncariId": "62ea1427d0c01697a5f2cfbb",
      "occurredAt": "2022-08-03T07:37:01.124Z",
      "entityId": "62ea12e141acf6979fac1ef9",
      "entityName": "contact__c",
      "sourceId": "62ea1427d0c01697a5f2cfbb",
      "operation": "update",
      "transactionDetails": [
        {
          "fieldId": "62ea12e241acf6979fac1fbc",
          "fieldApiName": "hs_time_in_subscriber",
          "fieldDisplayName": "Time in 'Subscriber (Lifecycle Stage Pipeline)'",
          "oldValue": 10765422045,
          "newValue": 10769835875,
          "sourceSynapseId": "62e356c90864d6e7a76b0a44",
          "sourceSynapseName": "Hubspot",
          "sourceFieldId": "62e35c880864d6ec69ea0834",
          "sourceFieldName": "hs_time_in_subscriber"
        }
      ],
      "sources": [
        {
          "synapseId": "62e356c90864d6e7a76b0a44",
          "synapseName": "Hubspot",
          "externalId": "801",
          "lastModified": "2022-06-14T09:01:50.234Z"
        }
      ],
      "destination": [
        {
          "synapseName": "Hubspot",
          "isError": false,
          "isSkipped": true,
          "externalId": "62e35c880864d6ec69ea07b9",
          "details": "Skipped destination node Contact, connector Hubspot, as no change to be synced to destination.",
          "synapseId": "62e356c90864d6e7a76b0a44"
        }
      ]
    }
  ]
}

 

Transaction KPIs

Transaction Kpis Mandatory parameters are startDate and endDate.

 

Request Headers

 Name
 Type
 Required
syncariId

Id of the instance the API is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Query Parameters

 

NameTypeRequiredNotes
endDatestringrequired-table (1).svg

End of the range of records to return

Format: YYYY-MM-ddTHH:mm:sssZ

startDatestringrequired-table (1).svg

Start of the range of records to return

Format: YYYY-MM-ddTHH:mm:sssZ

entityNamestring 

Return only records with this syncari entity name

Example

Request Sample

curl --request GET --url https://api.syncari.com/api/v1/transactions/kpis?startDate=2025-05-07T00:00:00.000Z&endTime=2025-05-10T00:00:00.000Z \
    --header 'Accept: application/json' \
    --header 'Authorization: FTON46895FBIl' \
    --header 'Content-Type: application/json' \
    --header 'clientRequestId: 123456789' \
    --header 'syncariId: VBKIUF' 

 

Response Sample

{
    "transactions": 38552,
    "mostActiveEntity": "Contact__c2", # Accounts for entire instance.
    "mostActiveSynapse": "Datasets", # Accounts for entire instance.
    "newRecords": 6191,
    "updateRecords": 13891,
    "errorCount": 516
}
Share this

Was this article helpful?

0 out of 0 found this helpful