Skip to main content

Power BI

Legale provides Power BI report API to summarize users' document management.
Pagination is mandatory in this API.

API detail

Request

  • URL: /power-bi/?page=1&page_size=10
  • Method: GET
  • Query Params:
{
"page": 1,
"page_size": 10, // (maximum 500)
}

Response

Success

  • Status code: 200
  • Body:
{
"count": 1000,
"next": "https://api.legale.io/api/v2/power-bi/?page=2&page_size=10",
"previous": null,
"results": [
{
"sign_process_status": 4,
"sign_method": "certification",
"file_name": "Anexo_de_Pago_Starbien_-_Mediclic_docx_pdf",
"description": "",
"GUID": "ad9dddcd-7754-49af-bc81-0c5c8aea18a1",
"document_id": null,
"folder_path": "root/contract/company",
"smart_document": "Company contract default",
"reject_reason": null,
"reject_date": null,
"document_url": "http://localhost:5051/media/document/ad9dddcd-7754-49af-bc81-0c5c8aea18a1/document/Anexo_de_Pago_Starbien_-_Mediclic_docx_pdf-signed.pdf",
"evidence_url": "http://localhost:5051/document/file/ad9dddcd-7754-49af-bc81-0c5c8aea18a1/evidence/",
"signers": [
{
"firstname": "Signer",
"lastname1": "1",
"lastname2": "",
"email": "signer1@gmail.com",
"started_at": "2025-10-08T17:28:56.018630Z",
"signed_at": "2025-10-08T17:29:05.239635Z",
"expire_at": "2025-11-07T17:28:56.015904Z"
}
],
"attached_files": [
{
"file": "http://localhost:5051/media/document/43a7a899-cadd-4df9-996c-2ee3fd16d840/attached/aiuon.pdf",
"file_name": "document_id.pdf",
"expire_date": null
},
],
"variables": [
"Signer1",
"signer1@legale.io",
"12.434.534-0",
"44",
"Sí"
]
},
],
}
ValueTypeDescription
GUIDstrGUID of the document.
sign_process_statusintSign process status of the document. This is status of document that is for specified to user.
sign_methodstrSign method of the document. This is sign method of document that is for specified to user.
file_namestrFile name of the document.
descriptionstrDescription of the document.
document_idstrDocument ID that is specified by user.
folder_pathstrFolder path in Legale cloud, this folder path shows the location of document in user's explorer.
smart_documentstrName of smart document that the document is created from.
reject_reasonstrReason of reject that the rejector left.
reject_datedatetimeReject date in UTC.
document_urlstrFull URL of the document that can be downloaded from.
evidence_urlstrFull URL of the document evidence that can be downloaded from. This URL is available in case of only document is signed.
variableslistSmart document variable list. This is available in case of only the document is created from smart document.
  • signers
ValueTypeDescription
firstnamestrFirst name of signer
lastname1strFirst last name of signer
lastname2strSecond last name of signer
emailstrEmail of signer
started_atdatetimeDate and time when the sign process was started (in UTC)
signed_atdatetimeDate and time when the sign process was finished (in UTC). This value is available only when the signer finished sign process
expire_atdatetimeDate and time when the sign process will be expired.
  • attached_files
ValueTypeDescription
filestrFull URL of the attached file that can be downloaded from.
file_namestrFile name of the attached file
lastname2strSecond last name of signer
expire_atdatetimeDate and time when the attached file will be expired.
  • sign_process_status
ValueTypeDescription
0intReady to send to Workspace
1intReady to send to sign
2intReady to sign
3intIn sign process
4intSigned
5intRejected
6intSign flow paused
7intReady to approve
8intPending deletion
9intReady to upload approve
10intPending upload approve
11intUpload rejected
12intFlow terminated
101intSign link expired
  • sign_method
ValueTypeDescription
smsstrRemote sms
no_smsstrRemote no sms
email_pinstrRemote stamp
certificationstrCloud certificate
local_certificatestrLocal certificate
tablet_signstrMobile device
approvestrApprove remote
approve_legalestrApprove Legale
approve_apistrApprove API
signing_portalstrSigning portal
send_emailstrSend email
feastrFEA