Alfred v1.66.3.0
Alfred
Alfred
  • Introduction
  • Authentication
  • Event API
    • File Events
      • File Add To Job
      • File Category Create
      • File Category Delete
      • File Change Tag
      • File Done
      • File Extracted Data Create
      • File Extracted Data Delete
      • File Failed
      • File Move
      • File Move To Pending
      • File Move To Recycle Bin
      • File Property Create
      • File Property Delete
      • File Remove Tag
      • File Status Update
      • File Update
    • Job Events
      • JobCreateEvent
      • JobExceededRetriesEvent
      • JobFailedEvent
      • JobFinishedEvent
      • JobInvalidEvent
      • JobRetryEvent
      • JobStageUpdateEvent
      • JobStartEvent
    • Event Structures
  • endpoints
    • Alfred
    • File
      • Remote Sources
      • File Status
    • Deferred Session
    • Job
      • Job Stages
    • Tag
    • Metadata
    • Metadata Values
    • Report
    • Account
    • Company
Powered by GitBook
On this page

Was this helpful?

  1. endpoints

Report

Alfred's Report namespace offers a streamlined solution for end-users to access and analyze data extracted from documents based on specific Tags. This functionality is essential for compiling detailed reports that reflect the outcomes of document processing within Alfred's Intelligent Document Processing (IDP) platform.

The reporting feature enables users to efficiently extract and review data points associated with different Tags. It is a key tool for decision-making, allowing users to evaluate the performance of document processing and gain valuable insights from the extracted content. The documentation in this section provides guidance on utilizing the reporting endpoint, detailing the types of data available for retrieval and the structure of the report outputs.

Get report by tag ID

GET https://tagshelf.host/api/report/tag/:id

Get a report with metadata values confirmed for files from the specified Tag.

Path Parameters

Name
Type
Description

id

UUID

Tag ID

Headers

Name
Type
Description

X-TagshelfAPI-Key

String

Application API Key

Authorization

String

Bearer <access_token> or amx <hmac_token>

[
    {
        "file_id": "5fcee04a-7102-40a2-9d4a-aee3c3c39bb",
        "rnc": "1923829",
        "monto": "390.00",
        "fecha": "2022-02-03"
    },
    ...
]

Last updated 9 months ago

Was this helpful?