Jump to

• Request
• Response
• Examples

Get all transaction metrics by time frame

get

/api/erp/integrations/resources/v1/{locale}/stats/transactionCountSummary

Returns the count of transactions processed within a given time frame.

Request

Path Parameters

• locale(required): string
  The locale to which the file is being uploaded.

  Example:

  en-us

Query Parameters

• flowName: string
  The name of the flow for which the service is being invoked.
• time: string
  The time frame for which the transaction metrics are fetched. Valid values are 1, 2, 3, and so on. The number indicates the number of days. For example, 1 indicates one day and 2 indicates two days.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Simple JSON containing aggregated transactions count for a particular timeframe

Body ()

Root Schema : TotalTransactionCount

Type: object

Show Source

• accountedTransactionCount: integer (int64)
  The count of transactions that are successfully accounted within the specfied upload time frame.
• errorTransactionCount: integer (int64)
  The count of transactions in error within the specfied upload time frame.
• flowName: string
  The name of the flow for which the service is being invoked.
• inProgressTransactionCount: integer (int64)
  The count of transactions that are in processing within the specfied upload time frame.
• totalTransactionCount: integer (int64)
  The count of transactions that were uploaded within the specified time frame.
• uploadedFrom: string
  Indicates the start date and time of the time range within which the files are uploaded.
• uploadedTo: string
  Indicates the end date and time of the time range within which the files are uploaded.

{
    "properties":{
        "flowName":{
            "description":"The name of the flow for which the service is being invoked.",
            "type":"string"
        },
        "totalTransactionCount":{
            "description":"The count of transactions that were uploaded within the specified time frame.",
            "format":"int64",
            "type":"integer"
        },
        "accountedTransactionCount":{
            "description":"The count of transactions that are successfully accounted within the specfied upload time frame.",
            "format":"int64",
            "type":"integer"
        },
        "errorTransactionCount":{
            "description":"The count of transactions in error within the specfied upload time frame.",
            "format":"int64",
            "type":"integer"
        },
        "inProgressTransactionCount":{
            "description":"The count of transactions that are in processing within the specfied upload time frame.",
            "format":"int64",
            "type":"integer"
        },
        "uploadedFrom":{
            "description":"Indicates the start date and time of the time range within which the files are uploaded.",
            "type":"string"
        },
        "uploadedTo":{
            "description":"Indicates the end date and time of the time range within which the files are uploaded.",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Examples

You can use this GET REST operation to get the number of the accounting hub transaction processed over a timeframe.

Example URL

Here's an example of the resource URL:

GET

/api/erp/integrations/resources/v1/{locale}/stats/transactionCountSummary

cURL Command

curl --location 'https://servername.fa.us2.oraclecloud.com/api/erp/inboundmonitoring/resources/v1/stats/transactionCountSummary?flowName=fah-import&time=1' \
--header 'Authorization: Bearer '<Bearer Token>

Example Response

Here's an example of the response body in JSON format:

{   
    "flowName":"fah-import",
    "totalTransactionCount":100,
    "accountedTransactionCount":100,
    "errorTransactionCount":50",
    "inProgressTransactionCount":0,
    "uploadedFrom": "2021-12-03T07:53:21.499111Z"
    "uploadedTo": "2021-12-04T07:53:21.499111Z",
}

Back to Top