{"info":{"_postman_id":"3f88051c-11af-44ad-9411-025cb6dbb1df","name":"Documoto BI Data Extracts","description":"

The following exports run once per day at 00:10:00 UTC. Results are written as CSV files to AWS S3 for customers to download.

Process for Retrieving and Downloading Files via APIs

Follow these steps to retrieve and download files using RESTful APIs:

1. Retrieve Available Files

Make a GET request to the endpoint (e.g., /list-files?environment={int or prod}) to obtain a list of files.
\n
Parse the API response, returned in JSON, extracting details to identify the file you want.
\n

2. Generate Download Link

Make another API call to an endpoint (e.g., /generate-link?filename={filename}) to generate a temporary download URL.
\n
- Optionally, call /latest-daily-link?environment={int or prod} to generate a download link for all daily exports in a single zip.
\n
The response will include a secure URL valid for downloading the requested file.
\n

3. Download the File

Use the provided download link to issue an HTTPS GET request.
\n
This requires the same API Key header as prior requests.
\n
Save the downloaded file locally or process it as required.
\n

This structured workflow provides a secure, efficient way to manage file retrieval and downloading through RESTful APIs.

1. Access Controls

Purpose
Provide a catalog of all media with their locale, organizational ownership, and template status to support access‐control audits and reporting.

Key Columns

Media ID – Internal ID of the media record.
\n
Type – Media type (e.g., IMAGE, VIDEO, DOCUMENT).
\n
Created / Updated – Timestamps for creation and last update.
\n
Template? – Boolean flag indicating if the media is a template.
\n
Identifier – Media identifier (external or human‑readable ID).
\n
Lang Name / Locale – Primary language name and locale code
\n
Media Name – Name/title of the media.
\n
Org Name – Name of the owning or associated organization.
\n
MC Lang Name / MC Locale / MC Name – Media-category translation details
\n

\n\n

Purpose
All user login and logout events—including SSO, API-key users, session timeouts, and client details—for security monitoring and usage analytics.

Key Columns

Session ID – Unique session identifier.
\n
Organization Name – Name of the user's organization.
\n
Username – Username or API key name (for API users).
\n
IP Address / Country – IP address used for the login and country it resolves to.
\n
Login Type – How the user logged in (Login Page, Direct URL, SSO, or Unknown).
\n
Browser or Agent – Browser user agent string or integration agent.
\n
Login Date / Logout Date – When the user login/logout occurred.
\n
Timeout Date – When the session timed out (derived if not explicitly set).
\n

3. Media Tags

Purpose
All media along with any user-defined tag values (single values or ranges) to enable filtering and attribute-based search.

Key Columns

ID – Internal ID of the media record.
\n
Media Identifier – Media identifier string.
\n
File or URL – Underlying file name or external media URL.
\n
Media Type – Type of media (document, image, video, external, interactive, etc.).
\n
Media Created/Updated – When the media record was created and last updated.
\n
Locale – Locale code of the media translation.
\n
Media Name / Description – Name/description of the media.
\n
Tag Name – Name of the tag applied to the media.
\n
Tag Value – Value of the tag (single value or composed from prefix/lower/upper/suffix).
\n

4. Page Part Tags

Purpose
List all parts used on each page, along with any part-level tags and quantities, for parts-usage reporting and downstream integrations.

Key Columns

Part ID – Internal ID of the part used on the page.
\n
Part Number – Part number (raw or from part number code).
\n
Part Name – Display name of the part (first available translation).
\n
Page ID – Internal ID of the page.
\n
Page Filename – File name of the page where the part appears.
\n
Page Name – Display name of the page (first available translation).
\n
Supplier Key – Supplier key associated with the part.
\n
Part Quantity – Quantity of the part on the page.
\n
Tag Name – Name of the tag applied to the page‑part relationship.
\n
Tag Value – Tag value for the page‑part relationship (single value or composed from prefix/lower/upper/suffix)..
\n

5. Page Tags

Purpose
Export metadata and tagging information for every page in the system, enabling localized page indexing and attribute-driven feeds.

Key Columns

ID – Internal ID of the page.
\n
Page File – Page file name.
\n
Type – File type/extension of the page.
\n
Created / Updated – When the page was created and last updated.
\n
Language Name – Name of the language for the translation.
\n
Language Code – Short language code.
\n
Language Code 4 – Four‑character locale code.
\n
Name / Description – Display name/description of the page.
\n
Tag Name – Name of the tag applied to the page.
\n
Tag Value – Value of the tag (single value or composed from prefix/lower/upper/suffix).
\n

6. Part Tags

Purpose
Compile part master data with user-defined tags to support catalog exports and part attribute filtering.

Key Columns

Part ID – Internal ID of the part.
\n
Part Number – Visible part number (raw or derived from part number code).
\n
Supplier – Supplier key for the part.
\n
UOM – Unit of measure for the part.
\n
Visible – Whether the part number is visible to end users.
\n
Orderable – Whether the part is orderable (True/False).
\n
Part Created/Updated – When the part record was created and last updated.
\n
Language Name – Name of the language for the part translation.
\n
Language Code 4 – Four‑character locale code.
\n
Name / Description – Display name/description of the part.
\n
Tag Name – Name of the tag applied to the part.
\n
Tag Value – Value of the tag (single value or composed from prefix/lower/upper/suffix).
\n

7. Search Log

Purpose
Capture every in-application search event, filters applied, click-through rates, and content targeted for search-performance analysis.

Key Columns

Created – When the search was performed.
\n
Username – Username or API key name that performed the search.
\n
Organization Name – Organization associated with the user.
\n
Search Term – Raw search query string.
\n
Search Filters – Serialized filters applied to the search.
\n
Results Count – Number of results returned by the search.
\n
Searched From – Where the search was initiated (Default, Quick Add, Browse Flow, General Search, Contextual Search Bar, etc.).
\n
Clicked Through? – Whether the user clicked through to any result.
\n
Content Type – Type of content returned (Part, Page, Book, Document, External, Microsite, Video, Image).
\n
Content Identifier – Identifier for the content item (part number, page file, or media identifier).
\n
Content Name – Human‑readable name of the content item.
\n

8. User Action Log

Purpose
Track user interactions (views of media, pages, chapters, parts, news items) to build engagement analytics and user-journey reports.

Key Columns

ID – Internal ID of the user action record.
\n
Session ID – Session identifier tied to the action.
\n
Created Date – Date the action occurred.
\n
Username – Username or API key name that performed the action.
\n
Organization – Organization of the user.
\n
Action – High‑level action type (View Media/Page/Chapter/News Item/Part).
\n
News Item – Name of the news item (if the action targets a bulletin).
\n
Media Type – Media type associated with the action (if applicable).
\n
Identifier – Media identifier associated with the action (if applicable).
\n
Media Name – Name of the media (first available translation).
\n
Chapter Name – Name of the chapter (first available translation).
\n
PageFile – File name of the page viewed.
\n
Page Name – Name of the page (first available translation).
\n
Part Number – Part number (raw or from part number code).
\n
Part Name – Name of the part (first available translation).
\n

9. Orders Log

Purpose
Track all submitted PO or RFQ's.

Key Columns

Created Date – When the order was created.
\n
Order ID – Identifier of the order.
\n
Type – Order type (PO for Purchase Order, RFQ for Request for Quote).
\n
Username – User who created the order.
\n
Organization Name – Organization of the ordering user.
\n
Part Number – Ordered part number.
\n
Supplier Key – Supplier key for the part.
\n
Part Name – Name of the ordered part (resolved from translations).
\n
Qty – Quantity ordered.
\n
Retail Price – Retail price per line item.
\n
Discounted Price – Discounted price per line item.
\n
Wholesale Price – Wholesale price per line item.
\n

10. BOM By Page

Purpose
Exports a simple bill of materials by page, listing every part instance on every page for a tenant. Useful for seeing which parts are used on which pages and in what quantity.

Key Columns

Page ID – Internal ID of the page that contains the part.
\n
Part ID – Internal ID of the part on the page.
\n
Part Number – Part number (raw or from part number code).
\n
Quantity – Quantity of the part on the page instance.
\n

11. Page Where Used

Purpose
Exports where pages are used within books for a tenant. Each row links a page to the media it belongs to, so you can see for a given book which pages it includes.

Key Columns

Page ID – Internal ID of the page.
\n
Page File – File name of the page.
\n
Media ID – Internal ID of the media that uses the page.
\n
Media Identifier – Identifier of the media that uses the page.
\n

12. Users Extract

Purpose
Exports all users and their respective Organization/User Group(s).

Key Columns

User ID – Internal ID of the user.
\n
Username – Username of the user.
\n
First Name – First name of the user.
\n
Last Name – Last name of the user.
\n
User Groups – Pipe seperated list of user groups a user belongs to.
\n
Organization – Name of the organization a user belongs to.
\n
Created Date – Date when the user was created.
\n
Last Login Date – Date when user last logged in.
\n
Enabled/Disabled – Value denoting if user is enabled or disabled.
\n
Expired – True/False value denoting if a user is expired.
\n
User Tag Name – Tag name value.
\n
User Tag Value – Users tag value.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34649711","collectionId":"3f88051c-11af-44ad-9411-025cb6dbb1df","publishedId":"2sB2qUo5Gc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-05-14T20:12:15.000Z"},"item":[{"name":"List Files","id":"feac26ef-d9bd-4b47-ac9c-52d6eaa62a4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://TENANT-KEY-HERE.app.documoto.com/download-reports/list-files?environment=prod&daily=true","description":"

Lists all exports that can be downloaded.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"123456"}]},"isInherited":true,"source":{"_postman_id":"3f88051c-11af-44ad-9411-025cb6dbb1df","id":"3f88051c-11af-44ad-9411-025cb6dbb1df","name":"Documoto BI Data Extracts","type":"collection"}},"urlObject":{"host":["https://TENANT-KEY-HERE.app.documoto.com/download-reports/list-files"],"query":[{"description":{"content":"

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":"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 exports for a given day.

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"},{"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 export.

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"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"123456"}]}},"event":[{"listen":"prerequest","script":{"id":"dfdf4197-2146-4ff6-9bb7-7480e82cc10f","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"8c2f1e87-8aba-470b-93a1-99bc2ed4d305","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://TENANT-KEY-HERE.app.documoto.com/download-reports/"},{"key":"bearerToken","value":"123456"}]}

Process for Retrieving and Downloading Files via APIs

1. Retrieve Available Files

2. Generate Download Link

3. Download the File

1. Access Controls

2. Login Log

3. Media Tags

4. Page Part Tags

5. Page Tags

6. Part Tags

7. Search Log

8. User Action Log

9. Orders Log

10. BOM By Page

11. Page Where Used

12. Users Extract