Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Request Logs

Retrieves the request logs of a specific duration. You can retrieve the either the logs of CHANGE_IDENTIFIER or GOODWILL.

get/request/logs

Query parameters

type'HANGE_IDENTIFIER' | 'GOODWILL' | 'TRANSACTION_UPDATE' required

Filters requests of a specific type.

start_datestring date

Get requests added on or after a specific date (YYYY-MM-DD). To get requests for a specific duration, pass the date-range in start_date and end_date.

end_datestring date

Get requests added before a specific date (YYYY-MM-DD). To get requests for a specific duration, pass the date-range in start_date and end_date.

base_type'MOBILE' | 'EXTERNAL_ID' | 'EMAIL' | 'MERGE' | 'ADDRESS' | 'COUPONS' | 'POINTS'

Sub type of the specified type.

status'APPROVED' | 'PENDING' | 'REJECTED'

Filters requests by request status.

request_idinteger

Unique ID of the request to fetch the log of a specific request.

limitinteger

Limits the number of results per page. For example, limit=10 shows 10 results per page on the UI.

mobilestring

Mobile number of the customer to get requests of a specific customer.

emailstring

Email ID of the customer to get requests of a specific customer.

external_idstring

External ID of the customer to get requests of a specific customer.

idinteger

Unique ID of the customer to get requests of a specific customer.

card_numberstring

Card number of the customer to get requests of a specific customer.

card_external_idstring

External ID of the customer's card to get requests of a specific customer.

start_idinteger

Get logs of requests starting on or after a specific ID. Get requests in a specific request range using start_id and end_id.

end_idinteger

Get logs of requests until a specific ID. Get requests in a specific request range using start_id and end_id.

format'xml' | 'json'

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "requests": {
      "count": "60",
      "rows": "10",
      "change_identifier": [
        {
          "id": "263452",
          "customer": {
            "firstname": "Tom",
            "lastname": "Sawyer",
            "email": "tom.sawyer@example.com",
            "mobile": "44700900000",
            "external_id": "ts123",
            "fraud_status": "NONE"
          },
          "type": "CHANGE_IDENTIFIER",
          "base_type": "EMAIL",
          "status": "PENDING",
          "old_value": "tom.sawyerold@example.com",
          "new_value": "tom.sawyer@example.com",
          "one_step_change": "false",
          "approval_type": "CLIENT",
          "logs": {
            "added_by": {
              "till": {
                "code": "Catherine",
                "name": "James"
              },
              "time": "2016-12-16T12:49:29+05:30"
            },
            "updated_by": {
              "user": {
                "name": "Catherine James",
                "mobile": "44700200030",
                "email": "catherine@example.com"
              },
              "ip": "115.114.139.186",
              "time": "2016-12-16T12:49:29+05:30"
            }
          }
        }
      ],
      "item_status": {
        "success": "true",
        "code": "9000",
        "message": "Request retrieved successfully"
      }
    }
  }
}