{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"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.\n\n---\n\n### Process for Retrieving and Downloading Files via APIs\n\nFollow these steps to retrieve and download files using RESTful APIs:\n\n---\n\n#### 1\\. Retrieve Available Files\n\n- Make a `GET` request to the endpoint (e.g., `/list-files?environment={int or prod}`) to obtain a list of files.\n    \n- Parse the API response, returned in JSON, extracting details to identify the file you want.\n    \n\n#### 2\\. Generate Download Link\n\n- Make another API call to an endpoint (e.g., `/generate-link?filename={filename}`) to generate a temporary download URL.\n    \n    - Optionally, call `/latest-daily-link?environment={int or prod}` to generate a download link for all daily exports in a single zip.\n        \n- The response will include a secure URL valid for downloading the requested file.\n    \n\n#### 3\\. Download the File\n\n- Use the provided download link to issue an HTTPS `GET` request.\n    \n- This requires the same API Key header as prior requests.\n    \n- Save the downloaded file locally or process it as required.\n    \n\nThis structured workflow provides a secure, efficient way to manage file retrieval and downloading through RESTful APIs.\n\n## 1\\. Access Controls\n\n**Purpose**  \nProvide a catalog of all media with their locale, organizational ownership, and template status to support access‐control audits and reporting.\n\n**Key Columns**\n\n- **Media ID** – Internal ID of the media record.\n    \n- **Type** – Media type (e.g., IMAGE, VIDEO, DOCUMENT).\n    \n- **Created / Updated** – Timestamps for creation and last update.\n    \n- **Template?** – Boolean flag indicating if the media is a template.\n    \n- **Identifier** – Media identifier (external or human‑readable ID).\n    \n- **Lang Name / Locale** – Primary language name and locale code\n    \n- **Media Name** – Name/title of the media.\n    \n- **Org Name** – Name of the owning or associated organization.\n    \n- **MC Lang Name / MC Locale / MC Name** – Media-category translation details\n    \n\n## 2\\. Login Log\n\n**Purpose**  \nAll user login and logout events—including SSO, API-key users, session timeouts, and client details—for security monitoring and usage analytics.\n\n**Key Columns**\n\n- **Session ID** – Unique session identifier.\n    \n- **Organization Name** – Name of the user's organization.\n    \n- **Username** – Username or API key name (for API users).\n    \n- **IP Address / Country** – IP address used for the login and country it resolves to.\n    \n- **Login Type** – How the user logged in (Login Page, Direct URL, SSO, or Unknown).\n    \n- **Browser or Agent** – Browser user agent string or integration agent.\n    \n- **Login Date / Logout Date** – When the user login/logout occurred.\n    \n- **Timeout Date** – When the session timed out (derived if not explicitly set).\n    \n\n## 3\\. Media Tags\n\n**Purpose**  \nAll media along with any user-defined tag values (single values or ranges) to enable filtering and attribute-based search.\n\n**Key Columns**\n\n- **ID** – Internal ID of the media record.\n    \n- **Media Identifier** – Media identifier string.\n    \n- **File or URL** – Underlying file name or external media URL.\n    \n- **Media Type** – Type of media (document, image, video, external, interactive, etc.).\n    \n- **Media Created/Updated** – When the media record was created and last updated.\n    \n- **Locale** – Locale code of the media translation.\n    \n- **Media Name / Description** – Name/description of the media.\n    \n- **Tag Name** – Name of the tag applied to the media.\n    \n- **Tag Value** – Value of the tag (single value or composed from prefix/lower/upper/suffix).\n    \n\n## 4\\. Page Part Tags\n\n**Purpose**  \nList all parts used on each page, along with any part-level tags and quantities, for parts-usage reporting and downstream integrations.\n\n**Key Columns**\n\n- **Part ID** – Internal ID of the part used on the page.\n    \n- **Part Number** – Part number (raw or from part number code).\n    \n- **Part Name** – Display name of the part (first available translation).\n    \n- **Page ID** – Internal ID of the page.\n    \n- **Page Filename** – File name of the page where the part appears.\n    \n- **Page Name** – Display name of the page (first available translation).\n    \n- **Supplier Key** – Supplier key associated with the part.\n    \n- **Part Quantity** – Quantity of the part on the page.\n    \n- **Tag Name** – Name of the tag applied to the page‑part relationship.\n    \n- **Tag Value** – Tag value for the page‑part relationship (single value or composed from prefix/lower/upper/suffix)..\n    \n\n## 5\\. Page Tags\n\n**Purpose**  \nExport metadata and tagging information for every page in the system, enabling localized page indexing and attribute-driven feeds.\n\n**Key Columns**\n\n- **ID** – Internal ID of the page.\n    \n- **Page File** – Page file name.\n    \n- **Type** – File type/extension of the page.\n    \n- **Created / Updated** – When the page was created and last updated.\n    \n- **Language Name** – Name of the language for the translation.\n    \n- **Language Code** – Short language code.\n    \n- **Language Code 4** – Four‑character locale code.\n    \n- **Name / Description** – Display name/description of the page.\n    \n- **Tag Name** – Name of the tag applied to the page.\n    \n- **Tag Value** – Value of the tag (single value or composed from prefix/lower/upper/suffix).\n    \n\n## 6\\. Part Tags\n\n**Purpose**  \nCompile part master data with user-defined tags to support catalog exports and part attribute filtering.\n\n**Key Columns**\n\n- **Part ID** – Internal ID of the part.\n    \n- **Part Number** – Visible part number (raw or derived from part number code).\n    \n- **Supplier** – Supplier key for the part.\n    \n- **UOM** – Unit of measure for the part.\n    \n- **Visible** – Whether the part number is visible to end users.\n    \n- **Orderable** – Whether the part is orderable (True/False).\n    \n- **Part Created/Updated** – When the part record was created and last updated.\n    \n- **Language Name** – Name of the language for the part translation.\n    \n- **Language Code 4** – Four‑character locale code.\n    \n- **Name / Description** – Display name/description of the part.\n    \n- **Tag Name** – Name of the tag applied to the part.\n    \n- **Tag Value** – Value of the tag (single value or composed from prefix/lower/upper/suffix).\n    \n\n## 7\\. Search Log\n\n**Purpose**  \nCapture every in-application search event, filters applied, click-through rates, and content targeted for search-performance analysis.\n\n**Key Columns**\n\n- **Created** – When the search was performed.\n    \n- **Username** – Username or API key name that performed the search.\n    \n- **Organization Name** – Organization associated with the user.\n    \n- **Search Term** – Raw search query string.\n    \n- **Search Filters** – Serialized filters applied to the search.\n    \n- **Results Count** – Number of results returned by the search.\n    \n- **Searched From** – Where the search was initiated (Default, Quick Add, Browse Flow, General Search, Contextual Search Bar, etc.).\n    \n- **Clicked Through?** – Whether the user clicked through to any result.\n    \n- **Content Type** – Type of content returned (Part, Page, Book, Document, External, Microsite, Video, Image).\n    \n- **Content Identifier** – Identifier for the content item (part number, page file, or media identifier).\n    \n- **Content Name** – Human‑readable name of the content item.\n    \n\n## 8\\. User Action Log\n\n**Purpose**  \nTrack user interactions (views of media, pages, chapters, parts, news items) to build engagement analytics and user-journey reports.\n\n**Key Columns**\n\n- **ID** – Internal ID of the user action record.\n    \n- **Session ID** – Session identifier tied to the action.\n    \n- **Created Date** – Date the action occurred.\n    \n- **Username** – Username or API key name that performed the action.\n    \n- **Organization** – Organization of the user.\n    \n- **Action** – High‑level action type (View Media/Page/Chapter/News Item/Part).\n    \n- **News Item** – Name of the news item (if the action targets a bulletin).\n    \n- **Media Type** – Media type associated with the action (if applicable).\n    \n- **Identifier** – Media identifier associated with the action (if applicable).\n    \n- **Media Name** – Name of the media (first available translation).\n    \n- **Chapter Name** – Name of the chapter (first available translation).\n    \n- **PageFile** – File name of the page viewed.\n    \n- **Page Name** – Name of the page (first available translation).\n    \n- **Part Number** – Part number (raw or from part number code).\n    \n- **Part Name** – Name of the part (first available translation).\n    \n\n## 9\\. Orders Log\n\n**Purpose**  \nTrack all submitted PO or RFQ's.\n\n**Key Columns**\n\n- **Created Date** – When the order was created.\n    \n- **Order ID** – Identifier of the order.\n    \n- **Type** – Order type (PO for Purchase Order, RFQ for Request for Quote).\n    \n- **Username** – User who created the order.\n    \n- **Organization Name** – Organization of the ordering user.\n    \n- **Part Number** – Ordered part number.\n    \n- **Supplier Key** – Supplier key for the part.\n    \n- **Part Name** – Name of the ordered part (resolved from translations).\n    \n- **Qty** – Quantity ordered.\n    \n- **Retail Price** – Retail price per line item.\n    \n- **Discounted Price** – Discounted price per line item.\n    \n- **Wholesale Price** – Wholesale price per line item.\n    \n\n## 10\\. BOM By Page\n\n**Purpose**  \nExports 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.\n\n**Key Columns**\n\n- **Page ID** – Internal ID of the page that contains the part.\n    \n- **Part ID** – Internal ID of the part on the page.\n    \n- **Part Number** – Part number (raw or from part number code).\n    \n- **Quantity** – Quantity of the part on the page instance.\n    \n\n## 11\\. Page Where Used\n\n**Purpose**  \nExports 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.\n\n**Key Columns**\n\n- **Page ID** – Internal ID of the page.\n    \n- **Page File** – File name of the page.\n    \n- **Media ID** – Internal ID of the media that uses the page.\n    \n- **Media Identifier** – Identifier of the media that uses the page.\n    \n\n## 12\\. Users Extract\n\n**Purpose**  \nExports all users and their respective Organization/User Group(s).\n\n**Key Columns**\n\n- **User ID** – Internal ID of the user.\n    \n- **Username** – Username of the user.\n    \n- First Name – First name of the user.\n    \n- Last Name – Last name of the user.\n    \n- **User Groups** – Pipe seperated list of user groups a user belongs to.\n    \n- **Organization** – Name of the organization a user belongs to.\n    \n- **Created Date** – Date when the user was created.\n    \n- **Last Login Date** – Date when user last logged in.\n    \n- **Enabled/Disabled** – Value denoting if user is enabled or disabled.\n    \n- **Expired** – True/False value denoting if a user is expired.\n    \n- User Tag Name – Tag name value.\n    \n- User Tag Value – Users tag value.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34649711","team":6232356,"collectionId":"3f88051c-11af-44ad-9411-025cb6dbb1df","publishedId":"2sB2qUo5Gc","public":true,"publicUrl":"https://documenter-api.postman.tech/view/34649711/2sB2qUo5Gc","privateUrl":"https://go.postman.co/documentation/34649711-3f88051c-11af-44ad-9411-025cb6dbb1df","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Collection of APIs to interact with daily exports"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.6","publishDate":"2025-05-14T20:12:15.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Collection of APIs to interact with daily exports","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/38bf6cf67ca4660db0cda60eb7410a953b70c634917fc212880ce799e13f92b0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB2qUo5Gc"}