Jump to

• Request
• Response

Get all transaction metrics by file and dimension

get

/api/erp/integrations/resources/v1/{locale}/dimensionView

Returns the count of transactions processed for a given dimensions combination, such as ledger and event type in a given time frame.

Request

Path Parameters

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

  Example:

  en-us

Query Parameters

• eventType: string
  The event type for which transaction metrics are fetched.
• flowName: string
  The name of the flow for which the service is being invoked.
• ledgerName: string
  The ledger for which transaction metrics are fetched.
• subLedgerName: string
  The subledger application for which transaction metrics are fetched.
• 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 transaction counts for a particular combination of dimensions in a particular timeframe

Body ()

Root Schema : DimensionBasedView

Type: object

Show Source

• dimensions: array dimensions
  The different dimension values used to filter the transaction metrics within a specified time frame.
• flowName: string
  The name of the flow for which the service is being invoked.

  Example: fah-import
• headerCount: object headerCount
  The count of transactions processed for the specified dimensions and time frame.
• lineCount: object lineCount
  The count of transaction lines processed for the specified dimensions and 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.",
            "example":"fah-import",
            "type":"string"
        },
        "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"
        },
        "dimensions":{
            "description":"The different dimension values used to filter the transaction metrics within a specified time frame.",
            "example":"LedgerName : OFS Ledger US",
            "items":{
                "$ref":"#/components/schemas/Dimension"
            },
            "type":"array"
        },
        "headerCount":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/HeaderCounts"
                }
            ],
            "description":"The count of transactions processed for the specified dimensions and time frame.",
            "example":2378,
            "type":"object"
        },
        "lineCount":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LineCounts"
                }
            ],
            "description":"The count of transaction lines processed for the specified dimensions and time frame.",
            "example":53426,
            "type":"object"
        }
    },
    "type":"object"
}

Nested Schema : dimensions

Type: array

The different dimension values used to filter the transaction metrics within a specified time frame.

Show Source

• Array of: object Dimension

{
    "description":"The different dimension values used to filter the transaction metrics within a specified time frame.",
    "example":"LedgerName : OFS Ledger US",
    "items":{
        "$ref":"#/components/schemas/Dimension"
    },
    "type":"array"
}

Example:

LedgerName : OFS Ledger US

Nested Schema : headerCount

Type: object

The count of transactions processed for the specified dimensions and time frame.

Match All

The count of transactions processed for the specified dimensions and time frame.

Show Source

• object HeaderCounts

{
    "allOf":[
        {
            "$ref":"#/components/schemas/HeaderCounts"
        }
    ],
    "description":"The count of transactions processed for the specified dimensions and time frame.",
    "example":2378,
    "type":"object"
}

Example:

2378

Nested Schema : lineCount

Type: object

The count of transaction lines processed for the specified dimensions and time frame.

Match All

The count of transaction lines processed for the specified dimensions and time frame.

Show Source

• object LineCounts

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LineCounts"
        }
    ],
    "description":"The count of transaction lines processed for the specified dimensions and time frame.",
    "example":53426,
    "type":"object"
}

Example:

53426

Nested Schema : Dimension

Type: object

Show Source

• name: string
• value: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : HeaderCounts

Type: object

Show Source

• totalHeaderCount: integer (int64)
• totalHeaderErrorInLine: integer (int64)
• totalHeaderInError: integer (int64)
• totalHeaderInProcessing: integer (int64)
• totalHeaderInWarning: integer (int64)
• totalHeaderProcessed: integer (int64)

{
    "properties":{
        "totalHeaderCount":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderInError":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderProcessed":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderInWarning":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderErrorInLine":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderInProcessing":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : LineCounts

Type: object

Show Source

• totalLineCount: integer (int64)
• totalLineErrorInHeaders: integer (int64)
• totalLineErrorInRelatedLine: integer (int64)
• totalLineIgnored: integer (int64)
• totalLineInError: integer (int64)
• totalLineProcessed: integer (int64)

{
    "properties":{
        "totalLineCount":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineInError":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineProcessed":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineErrorInRelatedLine":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineErrorInHeaders":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineIgnored":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Back to Top