Get Target Completion Details

The API retrieves target completion details for the event log IDs related to TargetCompleted events.

🚧

Note

This is a private API and is accessible only through Neo dataflows.

Prerequisites

  • Access to Neo
  • Basic or OAuth authentication details
  • Access group resource - NA

Resource information

URI to be used in Neo dataflow/das/getTargetCompletedExplodeLedger
HTTP methodGET
Pagination supported?Yes
Rate limitBased on Neo
Batch supportNA

Request Query Parameters

Parameter (Parameters marked with * are mandatory)Data TypeDescription
ledgerEntryTypes*StringType of entry recorded in a customer's points ledger. Allowed values: CREDIT, DEBIT
userId*LongUnique customer ID of the customer
endDate*DateLast date to which you want to retrieve the ledger information. Format: YYYY-MM-DD. Example: 2025-06-22
startDate*DateStart date to which you want to retrieve the ledger information. Format: YYYY-MM-DD. Example: 2025-06-01
alternateCurrencyNamesStringName of the alternate currency for which ledger information is retrieved.
pageIntegerRetrieve details of a specific page. Page count starts from 1. Example: page=2 retrieves data on page 2.
countIntegerNumber of results to display per page. The default value is 10. The maximum supported value is 100.

Response Parameters

ParameterData TypeDescription
request_idStringUnique identifier for the request.
dataObjectContains the main data structure for the request.
-recordsArrayA collection of records associated with the request.
-- fieldsObjectContains the fields for each record.
--- sourceIdObjectUnique identifier for the source, represented as a number.
--- parentEventLogIdObjectUnique identifier for the parent event log, represented as a number.
--- periodIdObjectIdentifier for the period, represented as a null value if not applicable.
--- returnEventLogIdObjectUnique identifier for the return event log, represented as a number.
--- targetAchievedEventLogIdObjectUnique identifier for the target achieved event log, represented as a number.
--- targetGroupNameObjectName of the target group, represented as a string.
--- processingTimeObjectTime taken for processing, represented as a number.
--- targetGroupDescriptionObjectDescription of the target group, represented as a string.
--- eventTypeIdObjectUnique identifier for the event type, represented as a number.
--- sourceTypeObjectType of the source, represented as a string.
--- billIdObjectUnique identifier for the bill, represented as a number.
--- customerIdObjectUnique identifier for the customer, represented as a number.
--- eventTimeObjectTimestamp indicating when the event occurred, represented as a number.
--- targetAchievedEventLogCreatedOnObjectTimestamp indicating when the target achieved event log was created, represented as a number.
--- targetGroupIdObjectUnique identifier for the target group, represented as a number.
--- eventLogIdObjectUnique identifier for the event log, represented as a number.
--- tillIdObjectUnique identifier for the till, represented as a number.
--- uniqueIdObjectUnique identifier for this specific event instance, represented as a string.
---unifiedTargetsAchievedCreatedOnObjectTimestamp indicating when the unified targets achieved was created, represented as a null value if not applicable.

Response sample

{
    "request_id": "15c96f72-8eeb-4a82-8e73-dd800d2c16ba",
    "data": {
        "records": [
            {
                "fields": {
                    "sourceId": {
                        "number_value": 2476935
                    },
                    "parentEventLogId": {
                        "number_value": 38731902
                    },
                    "periodId": {
                        "null_value": "NULL_VALUE"
                    },
                    "returnEventLogId": {
                        "number_value": -1
                    },
                    "targetAchievedEventLogId": {
                        "number_value": 468000
                    },
                    "targetGroupName": {
                        "string_value": "Test_Behavioural_Event_Target"
                    },
                    "processingTime": {
                        "number_value": 1748950111000
                    },
                    "targetGroupDescription": {
                        "string_value": "Test_Behavioural_Event_Target"
                    },
                    "eventTypeId": {
                        "number_value": 25
                    },
                    "sourceType": {
                        "string_value": "USERTARGET"
                    },
                    "billId": {
                        "number_value": 468000
                    },
                    "customerId": {
                        "number_value": 387970841
                    },
                    "eventTime": {
                        "number_value": 1748950110000
                    },
                    "targetAchievedEventLogCreatedOn": {
                        "number_value": 1748950111000
                    },
                    "targetGroupId": {
                        "number_value": 74503
                    },
                    "eventLogId": {
                        "number_value": 38731904
                    },
                    "tillId": {
                        "number_value": 50692627
                    },
                    "uniqueId": {
                        "string_value": "1ff9d4953610d8aa0924b24676b34c8c86f6502c"
                    },
                    "unifiedTargetsAchievedCreatedOn": {
                        "null_value": "NULL_VALUE"
                    }
                }
            }
        ]
    }
}

Error Code

Error CodeDescription
400Bad Request
404Not Found
500Internal Server Error
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!