Documoto's BI Data Extracts provide secure, automated access to customer-specific data from your Documoto environment(s). Data extracts are generated once daily and made available as CSV files, enabling you to integrate Documoto data with your organization’s business intelligence, reporting, and analytics solutions.
\nBI Data Extracts provide structured access to operational, usage, and transactional data, helping you gain insights into:
\nContent and media performance
\nUser behavior and engagement
\nSearch and application usage trends
\nOrder and quote activity
\nPlatform adoption and utilization
\nMetadata and content relationships
\nThe extracted data can be imported into analytics platforms that support CSV data sources, including:
\nMicrosoft Power BI
\nTableau
\nLooker
\nQlik Sense
\nDomo
\nSisense
\nThoughtSpot
\nIBM Cognos Analytics
\nData extracts are generated daily at 00:10:00 UTC, securely stored in Amazon S3, and available for download using the BI Data Extracts REST APIs documented in this collection.
\n","_postman_id":"bdd5eb82-eb4c-4e4a-b647-a6e0e7232fdf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve BI Data Extract files using the following three-step process:
\nMake a GET request to the endpoint (e.g., /list-files?environment={int or prod}) to obtain a list of files.
Parse the API response, returned in JSON, extracting details to identify the file you want.
\nMake another API call to an endpoint (e.g., /generate-link?filename={filename}) to generate a temporary download URL.
/latest-daily-link?environment={int or prod} to generate a download link for all daily exports in a single zip.The response will include a secure URL valid for downloading the requested file.
\nUse the provided download link to issue an HTTPS GET request.
This requires the same API Key header as prior requests.
\nSave the downloaded file locally or process it as required.
\nLists all extracts that can be downloaded
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Documoto environment exports generated against.
\n","type":"text/plain"},"key":"environment","value":"prod"},{"description":{"content":"(Optional) Only returns daily zips containing all exports.
\n","type":"text/plain"},"key":"daily","value":"true"}],"variable":[]}},"response":[{"id":"727dd85e-d9a2-4db8-a406-522e074469c4","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://TENANT-KEY-HERE.app.documoto.com/download-reports/list-files?environment=prod","host":["https://TENANT-KEY-HERE.app.documoto.com/download-reports/list-files"],"query":[{"key":"environment","value":"prod"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 May 2025 18:11:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2688"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"}],"cookie":[],"responseTime":null,"body":"{\n \"customer\": \"DOCUMOTO\",\n \"environment\": \"int\",\n \"folder\": null,\n \"start_date\": null,\n \"end_date\": null,\n \"files\": [\n \"int/AccessControls/AccessControls-2025_04_15.csv.gz\",\n \"int/AccessControls/AccessControls-2025_04_16.csv.gz\",\n \"int/AccessControls/AccessControls-2025_04_18.csv.gz\",\n \"int/AccessControls/AccessControls-2025_04_23.csv.gz\",\n \"int/AccessControls/AccessControls-2025_04_24.csv.gz\",\n \"int/AccessControls/AccessControls-2025_04_25.csv.gz\",\n \"int/AccessControls/AccessControls-2025_05_01.csv.gz\",\n \"int/LoginLog/LoginLog-2025_04_15.csv.gz\",\n \"int/LoginLog/LoginLog-2025_04_16.csv.gz\",\n \"int/LoginLog/LoginLog-2025_04_18.csv.gz\",\n \"int/LoginLog/LoginLog-2025_04_23.csv.gz\",\n \"int/LoginLog/LoginLog-2025_04_24.csv.gz\",\n \"int/LoginLog/LoginLog-2025_04_25.csv.gz\",\n \"int/LoginLog/LoginLog-2025_05_01.csv.gz\",\n \"int/MediaTags/MediaTags-2025_04_15.csv.gz\",\n \"int/MediaTags/MediaTags-2025_04_16.csv.gz\",\n \"int/MediaTags/MediaTags-2025_04_18.csv.gz\",\n \"int/MediaTags/MediaTags-2025_04_23.csv.gz\",\n \"int/MediaTags/MediaTags-2025_04_24.csv.gz\",\n \"int/MediaTags/MediaTags-2025_04_25.csv.gz\",\n \"int/MediaTags/MediaTags-2025_05_01.csv.gz\",\n \"int/PagePartTags/PagePartTags-2025_04_15.csv.gz\",\n \"int/PagePartTags/PagePartTags-2025_04_16.csv.gz\",\n \"int/PagePartTags/PagePartTags-2025_04_18.csv.gz\",\n \"int/PagePartTags/PagePartTags-2025_04_23.csv.gz\",\n \"int/PagePartTags/PagePartTags-2025_04_24.csv.gz\",\n \"int/PagePartTags/PagePartTags-2025_04_25.csv.gz\",\n \"int/PagePartTags/PagePartTags-2025_05_01.csv.gz\",\n \"int/PageTags/PageTags-2025_04_15.csv.gz\",\n \"int/PageTags/PageTags-2025_04_16.csv.gz\",\n \"int/PageTags/PageTags-2025_04_18.csv.gz\",\n \"int/PageTags/PageTags-2025_04_23.csv.gz\",\n \"int/PageTags/PageTags-2025_04_24.csv.gz\",\n \"int/PageTags/PageTags-2025_04_25.csv.gz\",\n \"int/PageTags/PageTags-2025_05_01.csv.gz\",\n \"int/PartTags/PartTags-2025_04_15.csv.gz\",\n \"int/PartTags/PartTags-2025_04_16.csv.gz\",\n \"int/PartTags/PartTags-2025_04_18.csv.gz\",\n \"int/PartTags/PartTags-2025_04_23.csv.gz\",\n \"int/PartTags/PartTags-2025_04_24.csv.gz\",\n \"int/PartTags/PartTags-2025_04_25.csv.gz\",\n \"int/PartTags/PartTags-2025_05_01.csv.gz\",\n \"int/SearchLog/SearchLog-2025_04_15.csv.gz\",\n \"int/SearchLog/SearchLog-2025_04_16.csv.gz\",\n \"int/SearchLog/SearchLog-2025_04_18.csv.gz\",\n \"int/SearchLog/SearchLog-2025_04_23.csv.gz\",\n \"int/SearchLog/SearchLog-2025_04_24.csv.gz\",\n \"int/SearchLog/SearchLog-2025_04_25.csv.gz\",\n \"int/SearchLog/SearchLog-2025_05_01.csv.gz\",\n \"int/UserActionLog/UserActionLog-2025_04_15.csv.gz\",\n \"int/UserActionLog/UserActionLog-2025_04_16.csv.gz\",\n \"int/UserActionLog/UserActionLog-2025_04_18.csv.gz\",\n \"int/UserActionLog/UserActionLog-2025_04_23.csv.gz\",\n \"int/UserActionLog/UserActionLog-2025_04_24.csv.gz\",\n \"int/UserActionLog/UserActionLog-2025_04_25.csv.gz\",\n \"int/UserActionLog/UserActionLog-2025_05_01.csv.gz\"\n ]\n}"}],"_postman_id":"feac26ef-d9bd-4b47-ac9c-52d6eaa62a4f"},{"name":"Generate Download Link","id":"f4fe6229-3373-4edf-9d7d-135098462930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://TENANT-KEY-HERE.app.documoto.com/download-reports/generate-link?filename=prod/AccessControls/AccessControls-2025_04_15.csv.gz","description":"Generate a download link for a specific extract
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Name of the file to download with full path
\n","type":"text/plain"},"key":"filename","value":"prod/AccessControls/AccessControls-2025_04_15.csv.gz"}],"variable":[]}},"response":[{"id":"18d4dbc5-0413-4e22-82c7-43f987d9c7f7","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://TENANT-KEY-HERE.app.documoto.com/download-reports/generate-link?filename=prod/AccessControls/AccessControls-2025_04_15.csv.gz","host":["https://TENANT-KEY-HERE.app.documoto.com/download-reports/generate-link"],"query":[{"key":"filename","value":"prod/AccessControls/AccessControls-2025_04_15.csv.gz"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 May 2025 18:12:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"}],"cookie":[],"responseTime":null,"body":"{\n \"link\": \"https://documoto.qa1.documoto.com/download-reports/file/c4e7ecdada23\"\n}"}],"_postman_id":"f4fe6229-3373-4edf-9d7d-135098462930"},{"name":"Latest Daily Link","id":"f3c4f892-754d-4ddd-9c1f-393767604262","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://TENANT-KEY-HERE.app.documoto.com/download-reports/latest-daily-link?environment=prod","description":"Generates a download link of all extracts for a given day
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Documoto environment exports generated against.
\n","type":"text/plain"},"key":"environment","value":"prod"}],"variable":[]}},"response":[{"id":"67ee9091-2551-4f0f-9573-3466e5d3fb7e","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://TENANT-KEY-HERE.qa1.documoto.com/download-reports/latest-daily-link?environment=prod","protocol":"https","host":["TENANT-KEY-HERE","qa1","documoto","com"],"path":["download-reports","latest-daily-link"],"query":[{"key":"environment","value":"prod"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 May 2025 18:12:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"uvicorn"}],"cookie":[],"responseTime":null,"body":"{\n \"link\": \"https://documoto.qa1.documoto.com/download-reports/file/c4e7ecdada23\"\n}"}],"_postman_id":"f3c4f892-754d-4ddd-9c1f-393767604262"}],"id":"3cc8a7c4-cae3-4e25-bcee-70db47efdd5c","_postman_id":"3cc8a7c4-cae3-4e25-bcee-70db47efdd5c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Exports media object details and their assgined organizations and media categories to support access control auditing and content management.
\nMedia ID – Internal ID of the media record
\nType – Type of media (e.g. Book, Document, Image, Video, etc.)
\nMedia Created - Date and time the media was created
\nMedia Updated - Data and time the media was last updated
\nTemplate? – True/False indicating if the media is a template
\nIdentifier – Unique identifier for the media record
\nLanguage Name – Name of the language for the media translation
\nLanguage Code 4 – Four‑character locale code for the media translation
\nMedia Name – Display name of the media
\nOrganization Name – Name of the organization the media is assigned to
\nMedia Category Language Name (\"MC Lang Name\") - Name of the language for the assigned media category
\nMedia Category Locale (\"MC Locale\") - Four‑character locale code for the assigned media category
\nMedia Category Name (\"MC Name\") - Display name of the assigned media category
\nExports the bill of materials (BOM) for every parts page, including associated parts and quantities, to analyze page-level part relationships.
\nPage ID - Internal ID for the page that contains the part
\nPart ID – Internal ID for the part on the page
\nPart Number - Part number or part code asosicated with the part
\nQuantity - Quantity of the part on the page
\nExports user sign-in activity, including session details and authentication information, to support security auditing and usage reporting.
\nSession ID - Unique identifer for the user session
\nOrganization Name - Name of organization associated with the user
\nUsername - Username or API Key associated with the session
\nIP Address - IP address from which the session orginiated.
\nCountry - Country derived from the IP address
\nLogin Type - Method used to authenticate (e.g. Login Page, Direct URL, or SSO)
\nBrowser or Agent - Browser or client application used during the session
\nLogin Date - Date and time the session began
\nLogout Date - Date and time the session ended
\nTimeout Date - Date and time the session expired
\nExports media and their associated tags to support metadata analysis and content management.
\nMedia ID - Internal ID of the media record
\nMedia Identifier – Unique identifier assigned to the media record
\nFile or URL – Filename or external URL associated with the media
\nMedia Type – Type of media (e.g. book, document, external, image, microsite, video, etc.)
\nMedia Created – Date and time the media was creaed
\nMedia Updated - Date and time the media was last updated
\nLocale – Locale code or language associated with the media translation
\nMedia Name – Display name of the media (first available translation)
\nMedia Description – Description of the media
\nTag Name – Name of the tag applied to the media
\nTag Value – Value of the tag (single value or composed from prefix/lower/upper/suffix) applied to the media
\nExports purchase order and request for quote (RFQ) activity, including ordered parts and pricing information, to support order analysis and reporting.
\nCreated Date – Date and time the order or quote was created
\nOrder ID – Unique idenitfier for the order or quote
\nType – Order type; PO for Purchase Order, RFQ for Request for Quote
\nUsername – Username who created the order or quote
\nOrganization Name – Name of the organization assigned to the ordering user
\nPart Number – Part number associated with the ordered part
\nSupplier Key – Supplier key associated with the ordered part
\nPart Name – Name of the ordered part (resolved from translations).
\nQuantity – Quantity associated with the ordered part
\nRetail Price – Retail price assocaited with the ordered part, per line item.
\nDiscounted Price – Discounted price assocaited with the ordered part, per line item.
\nWholesale Price – Wholesale price assocaited with the ordered part, per line item.
\nList of organizations, including parent organization name, number of users, number of assigned media, and any organization tag values
\nOrganization Name - Name of the organization
\nParent Organization Name - Name of the organization's parent organization (if applicable)
\nOrganization Tag Name - Name of the tag applied to the organization
\nOrgnaization Tag Value - Value of the tag applied to the organization
\nNumber of Users - Count of users in the organization
\nNumber of Assigned Media - Count of media objects assigned to the organization via access controls
\nExports page-part relationships and their associated tags to support metadata analysis and page-level part reporting.
\nPart ID – Internal ID of the part used on the page
\nPart Number – Part number or part code asosicated with the part
\nPart Name – Display name of the part (first available translation)
\nPage ID – Internal ID of the page where the part apepars
\nPage Filename – File name of the page where the part appears
\nPage Name – Display name of the page (first available translation)
\nSupplier Key – Supplier key associated with the part
\nPart Quantity – Quantity of the part on the page
\nTag Name – Name of the tag for the page‑part relationship
\nTag Value – Value of the tag for the page‑part relationship (single value or composed from prefix/lower/upper/suffix)
\nExports pages and their associated tags to support metadata analysis and content management.
\nID – Internal ID of the page record
\nPage File – Filename of the page record
\nType – File type or extension of the page record (e.g. SVG, PDF, JPG, etc.)
\nPage Created – Date and time the page was created
\nPage Updated - Date and time the page was last updated
\nLanguage Name – Display name of the language
\nLanguage Code – Two-character language code (e.g. en)
\nLanguage Code 4 – Four‑character language code (e.g. en_US)
\nPage Name – Display name of the page
\nPage Description – Description of the page
\nTag Name – Name of the tag applied to the page
\nTag Value – Value of the tag (single value or composed from prefix/lower/upper/suffix) applied to the page
\nExports page-to-media relationships to identify which books contain each page.
\nPage ID – Internal ID for the page record
\nPage File – File name of the page
\nMedia ID – Internal ID of the media that includes the page
\nMedia Identifier – Unique identifier of the media that includes the page
\nPurpose
\nExports parts and their associated tags to support metadata analysis and part management.
\nColumns
\nPart ID – Internal ID for the part
\nPart Number – Part number or part code asosicated with the part
\nSupplier – Supplier key for the part
\nUOM – Unit of measure for the part
\nVisible – Whether the part number is visible to end users in the Documoto Library
\nPart Created – Date and time the part was created
\nPart Updated – Date and time the part was last updated
\nOrderable – Whether the part is orderable (True/False)
\nLanguage Name – Name of the language for the part translation
\nLanguage Code 4 – Four‑character locale code
\nPart Name – Display name of the part
\nPart Description – Description of the part
\nTag Name – Name of the tag applied to the part
\nTag Value – Value of the tag (single value or composed from prefix/lower/upper/suffix) applied to the part
\nCapture every in-application search event, filters applied, click-through rates, and content targeted for search-performance analysis.
\nTimestamp – Date and time the search was performed
\nUsername – Username or API Key that performed the search
\nOrganization Name – Organization associated with the username or API Key
\nSearch Term – Search text entered by the username or API Key
\nSearch Filters – Filters applied to the search
\nResults Count – Number of results returned by the search
\nSearched From – Application area where the search was initiated (e.g. Contextual Search Bar, Browse Flow, etc.)
\nClicked Through? – Indicates whether the user selected a search result
\nContent Type – Type of content (e.g. Part, Page, Book, Document, External, Microsite, Video, Image, etc.) returned by the search
\nContent Identifier – Unique identifier for the content object (e.g. Part Number, Page Filename, or Media Identifier) returned by the search
\nContent Name – Display name for the content object returned by the search
\nTrack user interactions (views of media, pages, chapters, parts, news items) to build engagement analytics and user-journey reports.
\nID – Internal ID of the user action record
\nSession ID – Session identifier tied to the user action record
\nCreated Date – Date and time the user action occurred
\nUsername – Username or API Key that performed the action
\nOrganization – Organization of the username or API Key that performed the action
\nAction – Type of user action that was preformed (e.g. View Media, View Page, VIew Chapter, View Part, View News Item, etc.).
\nNews Item – Name of the News Item the user viewed (if applicable)
\nMedia Type – Type of media associated with the user action (if applicable)
\nIdentifier – Unique media identifier the user viewed (if applicable)
\nMedia Name – Name of the media the user viewed (if applicable) (first available translation)
\nChapter Name – Name of the chapter the user viewed (if applicable) (first available translation)
\nPage File – The filename of the page viewed (if applicable)
\nPage Name – Display name of the page (if applicable) (first available translation)
\nPart Number – Part number or part code associated with the part the user viewed (if applicable)
\nPart Name – Display name associated with the part the user viewed (if applicable) (first available translation)
\nExports all users and their respective Organization/User Group(s).
\nUser ID – Internal ID of the user.
\nUsername – Username of the user
\nFirst Name – First name of the user
\nLast Name – Last name of the user
\nUser Groups – Pipe seperated list of user group(s) the user is assigned to
\nOrganization – Name of the organization the user belongs to
\nCreated Date – Date and time the user was created
\nLast Login Date – Date and time user last logged in
\nEnabled/Disabled – True/False value denoting if user is enabled or disabled
\nExpired – True/False value denoting if a user is expired
\nUser Tag Name – Name of the tag applied to the user
\nUser Tag Value – Value of the tag applied to the user
\n