# Return Decision History

Returns a log of all previously ran decisions that the user has permission to access, optionally filtered.

Endpoint: GET /decisionEngine/usageLog
Version: 1.0.0
Security: bearerToken

## Query parameters:

  - `provenirId` (string)
    Filter the returned usage log by the GUID for the associated decision trees, obtained from .
    Example: "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"

  - `companyId` (string)
    Filter the returned usage log by the Connect ID for the associated companies for each decision.
    Example: "US001-X-US60521352"

  - `companyName` (string)
    Filter the returned usage log by the Company Name for the associated companies for each decision.
    Example: "CREDITSAFE"

  - `status` (number)
    Filter the returned usage log by the status for each decision.
    Example: 1

  - `fromDate` (string)
    Filter the returned usage log by the date the the decision was run.

  - `toDate` (string)
    Filter the returned usage log by the date the the decision was run.

  - `page` (integer)
    Starting page number.

  - `pageSize` (integer)
    Number of items to return per Page.

## Response 200 fields (application/json):

  - `totalCount` (number)
    The total number of previous decisions matching the defined filter criteria.
    Example: 3108

  - `usageLog` (array)

  - `usageLog.decisionLogId` (number)
    The unique identifier for the decision log.
    Example: 64492

  - `usageLog.provenirId` (string)
    The unique identifier of the decision tree.
    Example: "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"

  - `usageLog.friendlyName` (string)
    The name of the decision tree.
    Example: "Check & Decide Demo"

  - `usageLog.userId` (number)
    The unique identifier for the user's account, used across the Creditsafe product suite.
    Example: 101445010

  - `usageLog.companyId` (string)
    The connectId of the company that the decision was ran on. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.
    Example: "US001-X-US60521352"

  - `usageLog.companyName` (string,null)
    The name of the company that the decision was ran on.
    Example: "CREDITSAFE USA INC."

  - `usageLog.response` (object)

  - `usageLog.response.Decision` (string)
    The decision returned by the automated decision model.
    Example: "Reject"

  - `usageLog.response.DecisionText` (string)
    The text output to accompany the decision returned by the decision model.
    Example: "The Sales Value requested is greater than Creditsafe's recommended credit limit."

  - `usageLog.response.Audits` (array)
    An array of audit values. The parameters output for audit are tailored and bespoke to each decision tree.

  - `usageLog.response.Audits.description` (string)
    The value for the audit parameter at the point in time in which the decision tree was run.
    Example: "A"

  - `usageLog.response.Audits.RuleName` (string)
    The friendly name for the audit parameter.
    Example: "International Score"

  - `usageLog.response.originationId` (string,null)
    Displays the optional text passed through to be stored against the decision in the original call to . Typically used for internal identifiers (e.g. SalesForce IDs).
    Example: "SFC-1976"

  - `usageLog.response.statusCode` (string)
    The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.
    Example: "3"

  - `usageLog.decisionDate` (string)
    The timestamp that the decision model was run.

  - `usageLog.notes` (string,null)
    The notes associated with this decision.

  - `usageLog.status` (number)
    The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.
    Example: 3

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)