{ "opencollection": "1.0.0", "info": { "name": "SpringServe UI API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Account Partner Segments", "type": "folder" }, "items": [ { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/account_partner_segments", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/account_partner_segments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Bulk Update", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/account_partner_segments/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update" } ] }, { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts" }, "docs": "List all Accounts" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Get the currently active account for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/current" }, "docs": "Get the currently active account for the authenticated user" }, { "info": { "name": "Get the accounts that the current user can select as their current account context", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/displayable" }, "docs": "Get the accounts that the current user can select as their current account context" }, { "info": { "name": "Meta", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/meta" }, "docs": "Meta" }, { "info": { "name": "Get the defaults for a new account given an optional preset", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/new", "params": [ { "name": "preset", "value": "", "type": "query" } ] }, "docs": "Get the defaults for a new account given an optional preset" }, { "info": { "name": "Permissions Collection", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/permissions" }, "docs": "Permissions Collection" }, { "info": { "name": "Bulk DC Accounts (Curator)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/accounts/:id/bulk_connect_curators", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk DC Accounts (Curator)" }, { "info": { "name": "Bulk DC Accounts (DSP)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/accounts/:id/bulk_connect_dsps", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk DC Accounts (DSP)" }, { "info": { "name": "Bulk DC Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/accounts/:id/bulk_set_dc_visibility", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk DC Accounts" }, { "info": { "name": "DC Accounts (Curator)", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/:id/curator_dc_accounts", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "DC Accounts (Curator)" }, { "info": { "name": "DC Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/:id/dc_accounts", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "DC Accounts" }, { "info": { "name": "DC Accounts (DSP)", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/:id/dsp_dc_accounts", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "DC Accounts (DSP)" }, { "info": { "name": "Salesforce Sync", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/:id/salesforce_sync", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Salesforce Sync" }, { "info": { "name": "Set Current", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/accounts/:id/set_current", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set the active account for the authenticated user to the specified account id" }, { "info": { "name": "Used Partner Segment Vendors", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/:id/used_partner_segment_vendors", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Used Partner Segment Vendors" }, { "info": { "name": "Update Multiple Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/accounts/bulk/update", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple accounts in a single request. Returns different status codes based on success/failure ratio." }, { "info": { "name": "Set Current by Magnite DV+ ID", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/accounts/dvplus/:dvplus_id/set_current", "params": [ { "name": "dvplus_id", "value": "", "type": "path" } ] }, "docs": "Set the active account for the authenticated user to the account with the configured Magnite DV+ ID" }, { "info": { "name": "Show for Account by Foreign Seat", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/foreign_seat/:foreign_platform_name/:foreign_seat_id/white_label", "params": [ { "name": "foreign_platform_name", "value": "", "type": "path" }, { "name": "foreign_seat_id", "value": "", "type": "path" }, { "name": "include", "value": "", "type": "query" } ] }, "docs": "Show for Account by Foreign Seat" } ] }, { "info": { "name": "App Bundle Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_bundle_lists", "params": [ { "name": "app_bundle", "value": "", "type": "query", "description": "Filter using big-list api" } ] }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_bundle_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_bundle_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Get the App Bundles in an App Bundle List", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/app_bundles", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the App Bundles in an App Bundle List" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Add App Bundles", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/app_bundles/bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add App Bundles" }, { "info": { "name": "Delete App Bundles", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/app_bundles/bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete App Bundles" }, { "info": { "name": "Replace App Bundles", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/app_bundles/bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace App Bundles" }, { "info": { "name": "Add App Bundles (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/app_bundles/file_bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Add App Bundles (CSV)" }, { "info": { "name": "Delete App Bundles (CSV)", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/app_bundles/file_bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Delete App Bundles (CSV)" }, { "info": { "name": "Replace App Bundles (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_bundle_lists/:id/app_bundles/file_bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Replace App Bundles (CSV)" } ] }, { "info": { "name": "App Name Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_name_lists", "params": [ { "name": "app_name", "value": "", "type": "query", "description": "Filter using big-list api" } ] }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_name_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_name_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/app_name_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/app_name_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Bulk Update", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_name_lists/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_name_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Get all App Names in the list", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/app_names", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get all App Names in the list" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Add App Names", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/app_names/bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add App Names" }, { "info": { "name": "Delete App Names", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/app_names/bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete App Names" }, { "info": { "name": "Replace App Names", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/app_names/bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace App Names" }, { "info": { "name": "Add App Names (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/app_names/file_bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Add App Names (CSV)" }, { "info": { "name": "Delete App Names (CSV)", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/app_names/file_bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Delete App Names (CSV)" }, { "info": { "name": "Replace App Names (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/app_name_lists/:id/app_names/file_bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Replace App Names (CSV)" } ] }, { "info": { "name": "Creatives Audio", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/audio_creatives" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/audio_creatives", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/audio_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/audio_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/audio_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" } ] }, { "info": { "name": "Auth", "type": "folder" }, "items": [ { "info": { "name": "Authenticate and get a SpringServe API token", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/auth", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" }, { "name": "password", "value": "" } ] } }, "docs": "The returned API token should be used as the contents of the HTTP `Authorization` header in other authenticated API requests." }, { "info": { "name": "Authenticate and get user and account info", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/auth0/login", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" }, { "name": "password", "value": "" } ] } }, "docs": "Authenticate the user, and if valid, return basic info about the user, along with accounts they can access" }, { "info": { "name": "Retrieve basic info about a user by email address", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/auth0/users/:email", "params": [ { "name": "email", "value": "", "type": "path" } ] }, "docs": "If a user can be found with the provided email address, return the platform_type and role from their active user_account. Note: only SpringServe token based authentication works with this endpoint - you cannot use cookie based auth" } ] }, { "info": { "name": "Bills", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/bills" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/bills", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/bills/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/bills/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/bills/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/bills/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/bills/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Changelogs", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/changelogs", "params": [ { "name": "time", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query", "description": "Filter by user email, or special keywords: 'Optimization Only', 'Exclude Optimization', 'SpringCleaning Only', \n'Exclude SpringCleaning', 'DirectConnect Only', 'Exclude DirectConnect', 'DataMigration Only', 'Exclude DataMigration',\n'Exclude System Updates', 'High Volume Users Only' and 'Exclude High Volume Users'\n" }, { "name": "change_type", "value": "", "type": "query" } ] }, "docs": "List changelogs. Query parameters time (recommended), change_type, and user filter results. Available for ClearLine account types." }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/changelogs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "User Emails", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/changelogs/user_emails" }, "docs": "Get the list of User Emails to show for filtering changelogs by user" }, { "info": { "name": "versioned_types for the Current Account", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/changelogs/versioned_types_for_current_account" }, "docs": "Returns which versioned_types (and their display names) are applicable for the current account context" }, { "info": { "name": "Get By Type", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/changelogs/versioned_type/:versioned_type", "params": [ { "name": "versioned_type", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query", "description": "Searches by version change id and summary" }, { "name": "time", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query", "description": "all/exclude_system_updates/each_user" }, { "name": "change_type", "value": "", "type": "query", "description": "created/updated/deleted" }, { "name": "sort", "value": "", "type": "query" } ] }, "docs": "Get By Type" }, { "info": { "name": "Get By Type and Id", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/changelogs/versioned_type/:versioned_type/:versioned_id", "params": [ { "name": "versioned_type", "value": "", "type": "path" }, { "name": "versioned_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query", "description": "Searches by version change id and summary" }, { "name": "time", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query", "description": "all/exclude_system_updates/each_user" }, { "name": "change_type", "value": "", "type": "query", "description": "created/updated/deleted" }, { "name": "sort", "value": "", "type": "query" } ] }, "docs": "Get By Type and Id" } ] }, { "info": { "name": "City Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/city_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/city_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/city_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/city_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/city_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/city_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/city_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Content Categories", "type": "folder" }, "items": [ { "info": { "name": "List all content categories used by contextual signaling", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/content_categories" }, "docs": "Unpaginated list of content categories ordered by content_category_id" } ] }, { "info": { "name": "Country Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/country_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/country_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/country_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/country_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/country_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/country_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/country_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Creatives", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/creatives", "params": [ { "name": "additional_data", "value": "quickstats", "type": "query", "description": "Include additional data from non-model sources in the response. \nSupported values: 'quickstats', 'budget_data'. \nMultiple values can be specified as comma-separated (e.g., 'quickstats,budget_data').\n" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Index" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "additional_data", "value": "quickstats", "type": "query", "description": "Include additional data from non-model sources in the response. \nSupported values: 'quickstats', 'budget_data'. \nMultiple values can be specified as comma-separated (e.g., 'quickstats,budget_data').\n" } ] }, "docs": "Show" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Bulk Update", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/creatives/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple creatives with the same attributes in a single request." }, { "info": { "name": "Update Multiple Creatives", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/creatives/bulk/update", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple creatives independently in a single request. Returns different status codes based on success/failure ratio." } ] }, { "info": { "name": "Curated Marketplaces", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/curated_marketplaces" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/curated_marketplaces", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/curated_marketplaces/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/curated_marketplaces/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/curated_marketplaces/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Show curated_marketplaces across all accounts", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/curated_marketplaces/global" }, "docs": "Show minimal information (id, name, is_active) about all curated_marketplaces across all accounts" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/curated_marketplaces/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/curated_marketplaces/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Currencies", "type": "folder" }, "items": [ { "info": { "name": "List all currencies", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/currencies" }, "docs": "not paginated/filtered etc. Just list of all currencies in the map" } ] }, { "info": { "name": "Deal Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/deal_lists", "params": [ { "name": "deal_id", "value": "", "type": "query", "description": "Filter deal lists that contain the specified deal ID" } ] }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/deal_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/deal_lists/:deal_list_id", "params": [ { "name": "deal_list_id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/deal_lists/:deal_list_id", "params": [ { "name": "deal_list_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/deal_lists/:deal_list_id", "params": [ { "name": "deal_list_id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Bulk Update", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/deal_lists/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update" }, { "info": { "name": "Permissions Collection", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/deal_lists/permissions" }, "docs": "Permissions Collection" }, { "info": { "name": "Deals", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/deal_lists/:deal_list_id/deals", "params": [ { "name": "deal_list_id", "value": "", "type": "path" } ] }, "docs": "Deals" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/deal_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Add Deals", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/deal_lists/:deal_list_id/deals/bulk_create", "params": [ { "name": "deal_list_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Deals" }, { "info": { "name": "Delete Deals", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/deal_lists/:deal_list_id/deals/bulk_delete", "params": [ { "name": "deal_list_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Deals" }, { "info": { "name": "Replace Deals", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/deal_lists/:deal_list_id/deals/bulk_replace", "params": [ { "name": "deal_list_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace Deals" } ] }, { "info": { "name": "Demand Labels", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_labels", "params": [ { "name": "date_range", "value": "", "type": "query", "description": "Quickstats interval label (applies when `additional_data` contains `quickstats`). Defaults to Today." }, { "name": "currency", "value": "", "type": "query", "description": "Quickstats currency (applies when `additional_data` contains `quickstats`). Defaults to USD." } ] }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/demand_labels", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_labels/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "date_range", "value": "", "type": "query", "description": "Quickstats interval label (applies when `additional_data` contains `quickstats`). Defaults to Today." }, { "name": "currency", "value": "", "type": "query", "description": "Quickstats currency (applies when `additional_data` contains `quickstats`). Defaults to USD." } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/demand_labels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/demand_labels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_labels/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_labels/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Demand Tags", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags", "params": [ { "name": "additional_data", "value": "quickstats", "type": "query", "description": "Include additional data from non-model sources in the response. \nSupported values: 'quickstats', 'budget_data'. \nMultiple values can be specified as comma-separated (e.g., 'quickstats,budget_data').\n" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "demand_label_id", "value": "", "type": "query", "description": "Narrow results to demand tags linked to this demand label through demand_labelers\n(parity with the legacy demand tags index label filter). Invalid or zero values yield\nan empty result set.\n" }, { "name": "demand_tag_status", "value": "", "type": "query", "description": "Filter by demand tag status (legacy index parity). Values: active, inactive, new,\nreactivated. Unknown values return an empty result set. DSP sub-accounts only\nsupport active and inactive; other values return 400.\n" }, { "name": "demand_type", "value": "", "type": "query", "description": "Filter by demand type slug (legacy demand class filter). Values include managed, dc, hb,\ncreative, house_ad, line_item, programmatic_guaranteed, direct_io, direct_io_line_item.\nUnknown values return an empty result set.\n" }, { "name": "supply_environment", "value": "", "type": "query", "description": "Filter by supply environment on the demand tag. Use `any` for legacy \"Any\"\n(direct-connect environment or unset). Named `supply_environment` to avoid clashing\nwith the default column equality filter on `environment`.\n" }, { "name": "ad_server", "value": "", "type": "query", "description": "Filter by ad server bucket (legacy index parity): springserve, other, a header-bidding\nplatform key, or a VAST URL match string from configured ad servers.\n" } ] }, "docs": "List all Demand Tags" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/demand_tags", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "additional_data", "value": "quickstats", "type": "query", "description": "Include additional data from non-model sources in the response. \nSupported values: 'quickstats', 'budget_data'. \nMultiple values can be specified as comma-separated (e.g., 'quickstats,budget_data').\n" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/demand_tags/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/demand_tags/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete" }, { "info": { "name": "Update Multiple Demand Tags", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/demand_tags/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple demand tags with the same attributes in a single request. Returns different status codes based on success/failure ratio." }, { "info": { "name": "Download CSV", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/download", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of demand tag IDs, or array of demand tag IDs" }, { "name": "filename", "value": "", "type": "query", "description": "Optional custom filename for the CSV download" } ] }, "docs": "Download a CSV file with demand tag information for the specified demand tag IDs" }, { "info": { "name": "Suggest VAST endpoint macros", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/demand_tags/macro_suggester", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a macro-filled VAST endpoint URL and resolved ad_server_id for demand tag endpoint settings. Does not create or update a demand tag." }, { "info": { "name": "Get defaults for a new Demand Tag", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/new", "params": [ { "name": "demand_partner_id", "value": "", "type": "query", "description": "Optional param to add demand_partner_id on the new Demand Tag defaults." }, { "name": "campaign_id", "value": "", "type": "query", "description": "Optional param to add campaign_id on the new Default Tag defaults. Also populates demand_partner_id from the campaign if demand_partner_id is omitted." } ] }, "docs": "Returns the default values for a new Demand Tag." }, { "info": { "name": "Permissions Collection", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/permissions" }, "docs": "Permissions Collection" }, { "info": { "name": "Creatives Summary", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/:id/creatives_summary", "params": [ { "name": "id", "value": "", "type": "path", "description": "Demand Tag ID" } ] }, "docs": "Get reporting data for a campaign with comparison metrics. Returns raw numeric values with percentage changes \nfor all metrics. When forecast_date_range is provided, also returns forecast_summary\nand combined_summary.\n" }, { "info": { "name": "Duplicate Demand Tag", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/:id/duplicate", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns the default values for a new Demand Tag, copied from an existing Demand Tag" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Update Multiple Demand Tags", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/demand_tags/bulk/update", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple demand tags independently in a single request. Returns different status codes based on success/failure ratio." }, { "info": { "name": "New From Demand Forecast", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/demand_tags/new_from_forecast/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "include", "value": "", "type": "query" } ] }, "docs": "New From Demand Forecast" } ] }, { "info": { "name": "Domain Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists", "params": [ { "name": "domain", "value": "", "type": "query", "description": "search for the given domain in the lists" }, { "name": "domain_exact_match", "value": "", "type": "query", "description": "If the domain filter must be an exact match" } ] }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/domain_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/domain_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Bulk Update", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Domains", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists/:id/domains", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "preview", "value": "", "type": "query", "description": "If true, returns only a truncated preview of the domains (first ~80KB read from storage) instead of the full list" } ] }, "docs": "Domains" }, { "info": { "name": "Duplicate Domain List", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists/:id/duplicate", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns a non-persisted preview of a duplicate of the domain list." }, { "info": { "name": "Create Domain List Duplicate", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/duplicate", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Persists a new domain list from the submitted basic info and copies the original's domains into the new list. When demand partner expansion is enabled, demand_partner_permission_ids is required.\n" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Get added targeting resources for list association", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists/:id/:resource_type", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the domain list" }, { "name": "resource_type", "value": "", "type": "path", "description": "Type of targeting resource to fetch" } ] }, "docs": "Returns targeting resources (Supply Partners, Demand Partners, Campaigns, etc.) that are associated with a specific domain list." }, { "info": { "name": "Add domain list targeting for resources", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/:resource_type", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the domain list" }, { "name": "resource_type", "value": "", "type": "path", "description": "Type of targeting resource to add to the list" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates resources identified by `object_ids` with the specified domain list.\nAll resources in the request must use the same `is_allowlist` mode.\nResources with existing list associations must already use a compatible allowlist mode.\n" }, { "info": { "name": "Bulk Create Domains", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/domains/bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Create Domains" }, { "info": { "name": "Bulk Delete Domains", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/domain_lists/:id/domains/bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Delete Domains" }, { "info": { "name": "Bulk Replace Domains", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/domains/bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Replace Domains" }, { "info": { "name": "File Bulk Create Domains", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/domains/file_bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "account_id", "type": "text", "value": "" }, { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "File Bulk Create Domains" }, { "info": { "name": "File Bulk Delete Domains", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/domain_lists/:id/domains/file_bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "account_id", "type": "text", "value": "" }, { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "File Bulk Delete Domains" }, { "info": { "name": "File Bulk Replace Domains", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/domains/file_bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "account_id", "type": "text", "value": "" }, { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "File Bulk Replace Domains" }, { "info": { "name": "Available Resources", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/domain_lists/:id/:resource_type/available", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "resource_type", "value": "", "type": "path", "description": "Type of resource to retrieve" } ] }, "docs": "Returns resources available for targeting with this domain list. Filter is_allowlist defaults to false." }, { "info": { "name": "Bulk delete targeted resources from list", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/:resource_type/bulk_delete", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the domain list" }, { "name": "resource_type", "value": "", "type": "path", "description": "Type of targeting resource to remove from the list" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes resources identified by `object_ids` from the specified list.\nDoes not delete the resources themselves, only their association with the list.\nRemoving a resource that is not on the list is treated as success.\n" }, { "info": { "name": "Bulk update targeted resources", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/domain_lists/:id/:resource_type/bulk_update", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the domain list" }, { "name": "resource_type", "value": "", "type": "path", "description": "Type of targeting resource to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates allowlist vs blocklist mode for resources identified by `object_ids`.\nUse `is_allowlist` to set allowlist vs blocklist mode for each resource in `object_ids`.\n`is_allowlist` cannot be changed when a resource is associated with multiple lists.\n" } ] }, { "info": { "name": "Creatives Filepaths", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/filepath_creatives" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/filepath_creatives", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/filepath_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/filepath_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/filepath_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" } ] }, { "info": { "name": "Geo Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/geo_lists" }, "docs": "Index" }, { "info": { "name": "Bulk Update", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/geo_lists/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/geo_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/geo_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Global Fcap Pixels", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/global_fcap_pixels" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/global_fcap_pixels", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/global_fcap_pixels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/global_fcap_pixels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/global_fcap_pixels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/global_fcap_pixels/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/global_fcap_pixels/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Hb Bid Maps", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/hb_bid_maps" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/hb_bid_maps", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/hb_bid_maps/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/hb_bid_maps/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/hb_bid_maps/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/hb_bid_maps/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/hb_bid_maps/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Header Bidding Platforms", "type": "folder" }, "items": [ { "info": { "name": "List Header Bidding Platforms", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/header_bidding_platforms" }, "docs": "This is not a paginated/filtered list, but rather returns all results" }, { "info": { "name": "List restricted Header Bidding Platforms", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/header_bidding_platforms/restricted" }, "docs": "This is not a paginated/filtered list, but rather returns all results" } ] }, { "info": { "name": "ISP Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/isp_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/isp_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/isp_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/isp_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/isp_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/isp_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "ISP Names", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/isp_lists/:id/isp_names", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "ISP Names" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/isp_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Add ISPs", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/isp_lists/:id/isp_names/bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add ISPs" }, { "info": { "name": "Delete ISPs", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/isp_lists/:id/isp_names/bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete ISPs" }, { "info": { "name": "Replace ISPs", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/isp_lists/:id/isp_names/bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace ISPs" }, { "info": { "name": "Add ISPs (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/isp_lists/:id/isp_names/file_bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Add ISPs (CSV)" }, { "info": { "name": "Remove ISPs (CSV)", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/isp_lists/:id/isp_names/file_bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Remove ISPs (CSV)" }, { "info": { "name": "Replace ISPs (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/isp_lists/:id/isp_names/file_bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Replace ISPs (CSV)" } ] }, { "info": { "name": "Metro Area Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/metro_area_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/metro_area_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/metro_area_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/metro_area_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/metro_area_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/metro_area_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/metro_area_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Partner Segments", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/partner_segments", "params": [ { "name": "account_partner_segment_is_active", "value": "", "type": "query" }, { "name": "additional_data", "value": "", "type": "query", "description": "Include additional data from non-model sources on the result. Comma-delimited." } ] }, "docs": "Index" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/partner_segments/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "additional_data", "value": "", "type": "query", "description": "Include additional data from non-model sources on the result. Comma-delimited." } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/partner_segments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/partner_segments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Bulk Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/partner_segments/bulk_create", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Create" }, { "info": { "name": "Bulk Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/partner_segments/bulk_delete", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/partner_segments/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Get paginated list of active targeted partner segments for the active account", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/partner_segments/targeted", "params": [ { "name": "targeter_type", "value": "", "type": "query", "description": "Type of targeting object. Must be provided together with `targeter_id`." }, { "name": "targeter_id", "value": "", "type": "query", "description": "ID of the targeting object. Must be provided together with `targeter_type`." }, { "name": "id", "value": "", "type": "query", "description": "Equality filter on partner segment id." }, { "name": "code", "value": "", "type": "query", "description": "Equality filter on partner segment code" }, { "name": "description", "value": "", "type": "query", "description": "Equality filter on partner segment description" } ] }, "docs": "Returns partner segments targeted by any of the listed object types" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/partner_segments/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Permissions", "type": "folder" }, "items": [ { "info": { "name": "List system-wide permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/permissions" }, "docs": "List system-wide permissions that are not necessarily specific to a single resource type" }, { "info": { "name": "List component permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/permissions/apps" }, "docs": "List permissions for SpringServe components: supply, demand, targeting etc." } ] }, { "info": { "name": "Postal Code Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/postal_code_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/postal_code_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/postal_code_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/postal_code_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/postal_code_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/postal_code_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/postal_code_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Report", "type": "folder" }, "items": [ { "info": { "name": "Alias for POST /api/v1/reports", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/report", "body": { "type": "json", "data": "{}" } }, "docs": "Alias for POST /api/v1/reports" } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/reports", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Get Report", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/reports/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "sort", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" } ] }, "docs": "Get Report" }, { "info": { "name": "Download", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/reports/download/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zipped", "value": "", "type": "query" } ] }, "docs": "Download" } ] }, { "info": { "name": "Scanned Creative Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/scanned_creative_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/scanned_creative_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Creatives", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/creatives", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Creatives" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Add Creatives", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/creatives/bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Creatives" }, { "info": { "name": "Delete Creatives", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/creatives/bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Creatives" }, { "info": { "name": "Replace Creatives", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/creatives/bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace Creatives" }, { "info": { "name": "Add Creatives (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/creatives/file_bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Add Creatives (CSV)" }, { "info": { "name": "Delete Creatives (CSV)", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/creatives/file_bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Delete Creatives (CSV)" }, { "info": { "name": "Replace Creatives (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/scanned_creative_lists/:id/creatives/file_bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Replace Creatives (CSV)" } ] }, { "info": { "name": "Scheduled Reports", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/scheduled_reports", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "query" }, { "name": "user_account_id", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" } ] }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/scheduled_reports", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/scheduled_reports/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/scheduled_reports/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/scheduled_reports/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Bulk Update", "type": "http" }, "http": { "method": "PUT", "url": "https://console.springserve.com/api/v1/scheduled_reports/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update" } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Universal", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" } ] }, "docs": "Universal Search across all entity types" }, { "info": { "name": "Search within a given type of entity", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/:entity", "params": [ { "name": "entity", "value": "", "type": "path" }, { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "account_id", "value": "", "type": "query", "description": "Scope the search to the given account instead of your currently active account. Only supported for `streaming_publishers` and `streaming_seller_seats`." }, { "name": "demand_partner_permission_ids", "value": "", "type": "query", "description": "Filter based on the demand partner(s) selected for the given objects. Only supported for app_bundle_lists, app_name_lists, city_lists, country_lists, deal_lists, deals, metro_area_lists, global_fcap_pixels, ip_lists, postal_code_lists, publisher_id_lists, segments, state_lists, and streaming_seller_seat_lists." } ] }, "docs": "Search within a given type of entity" }, { "info": { "name": "Search for account managers", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/account_managers", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "partner_type", "value": "", "type": "query", "description": "filter by supply or demand partner account managers" } ] }, "docs": "Search for account managers" }, { "info": { "name": "Search for ad servers", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/ad_servers", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" } ] }, "docs": "Typeahead for VAST ad servers. Database rows include id for macro suggester; SpringServe, Other, and header-bidding platforms return id null." }, { "info": { "name": "Search for demand tags", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/campaigns", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "demand_partner_id", "value": "", "type": "query" }, { "name": "exclude_open_market", "value": "", "type": "query" } ] }, "docs": "Search for demand tags" }, { "info": { "name": "Search for supply partners", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/deal_lists", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "exclude_empty_list", "value": "", "type": "query" } ] }, "docs": "Search for supply partners" }, { "info": { "name": "Search for demand partners", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/demand_partners", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "supply_tag_id", "value": "", "type": "query", "description": "filter by Demand Partners associated with Demand Tags that are in Demand Tag Priorities for the specified Supply Tag" }, { "name": "managed", "value": "", "type": "query", "description": "filter by Managed (i.e. not Direct Connect) Demand Partners" }, { "name": "direct_connect", "value": "", "type": "query", "description": "filter by Direct Connect Demand Partners" }, { "name": "exclude_open_market", "value": "", "type": "query" } ] }, "docs": "Search for demand partners" }, { "info": { "name": "Search for demand tags", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/demand_tags", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "format", "value": "", "type": "query" }, { "name": "exclude_open_market", "value": "", "type": "query" } ] }, "docs": "Search for demand tags" }, { "info": { "name": "Search for displayable accounts", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/displayable_accounts", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "platform_type", "value": "", "type": "query" } ] }, "docs": "Search for displayable accounts" }, { "info": { "name": "Search for iab categories", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/iab_category", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "tier", "value": "", "type": "query" } ] }, "docs": "Search for iab categories" }, { "info": { "name": "Search for Keys", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/key_keys", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "definition_type", "value": "", "type": "query" } ] }, "docs": "Search for Keys" }, { "info": { "name": "Search for supply partners", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/supply_partners", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "direct_io_publishers_only", "value": "", "type": "query" }, { "name": "managed", "value": "", "type": "query", "description": "filter by Managed (i.e. not Direct Connect) Supply Partners" } ] }, "docs": "Search for supply partners" }, { "info": { "name": "Search for supply tags", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/supply_tags", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query", "description": "Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both." }, { "name": "format", "value": "", "type": "query" }, { "name": "waterfall_management", "value": "", "type": "query" } ] }, "docs": "Search for supply tags" }, { "info": { "name": "Search for user accounts", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/search/user_accounts", "params": [ { "name": "q", "value": "", "type": "query", "description": "the string to search for" }, { "name": "limit", "value": "", "type": "query", "description": "max number of results to return" }, { "name": "with_deleted", "value": "", "type": "query" }, { "name": "is_demand_forecast_creator", "value": "", "type": "query", "description": "filter by User Accounts that are associated with Demand Forecasts" }, { "name": "is_clearline_forecast_creator", "value": "", "type": "query", "description": "filter by User Accounts that are associated with Clearline Forecasts" }, { "name": "is_csv_report_creator", "value": "", "type": "query", "description": "filter by User Accounts that are associated with CSV Reports" }, { "name": "is_scheduled_report_creator", "value": "", "type": "query", "description": "filter by User Accounts that are associated with Scheduled Reports" }, { "name": "is_report_template_creator", "value": "", "type": "query", "description": "filter by User Accounts that are associated with Report Templates" } ] }, "docs": "Search for user accounts" } ] }, { "info": { "name": "Session", "type": "folder" }, "items": [ { "info": { "name": "Get current user session", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/session" }, "docs": "Gets current user session id, account id, and session information" }, { "info": { "name": "Delete current user session", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/session" }, "docs": "Delete current user session, logging them out from SpringServe UI" } ] }, { "info": { "name": "State Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/state_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/state_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/state_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/state_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/state_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/state_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/state_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Supply Labels", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_labels" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/supply_labels", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_labels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/supply_labels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/supply_labels/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_labels/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_labels/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Supply Name Lists", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_name_lists" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/supply_name_lists", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_name_lists/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" }, { "info": { "name": "Supply Names", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/supply_names", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Supply Names" }, { "info": { "name": "Add Supply Names", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/supply_names/bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Supply Names" }, { "info": { "name": "Delete Supply Names", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/supply_names/bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Supply Names" }, { "info": { "name": "Replace Supply Names", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/supply_names/bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace Supply Names" }, { "info": { "name": "Add Publishers Names (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/supply_names/file_bulk_create", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Add Publishers Names (CSV)" }, { "info": { "name": "Remove Supply Names (CSV)", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/supply_names/file_bulk_delete", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Remove Supply Names (CSV)" }, { "info": { "name": "Replace Supply Names (CSV)", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/supply_name_lists/:id/supply_names/file_bulk_replace", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "csv_file", "type": "text", "value": "" } ] } }, "docs": "Replace Supply Names (CSV)" } ] }, { "info": { "name": "Supply Tags", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_tags", "params": [ { "name": "curator_fees.curator_fee_publishers.publisher", "value": "", "type": "query" }, { "name": "curator_fees.curator_fee_publishers.inventory_source", "value": "", "type": "query" }, { "name": "curator_fees.curator_fee_publishers.ad_source_ids", "value": "", "type": "query" }, { "name": "marketplace_buyers.inventory_source", "value": "", "type": "query" }, { "name": "marketplace_buyers.dsp_id", "value": "", "type": "query" }, { "name": "optimization_is_active", "value": "", "type": "query" }, { "name": "optimization_version", "value": "", "type": "query" } ] }, "docs": "Index" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_tags/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Download CSV", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_tags/download", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of supply tag IDs, or array of supply tag IDs" }, { "name": "filename", "value": "", "type": "query", "description": "Optional custom filename for the CSV download" } ] }, "docs": "Download a CSV file with supply tag information for the specified supply tag IDs" }, { "info": { "name": "Collection Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_tags/permissions" }, "docs": "Collection Permissions" }, { "info": { "name": "Demand Tag Priorities", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_tags/:id/demand_tag_priorities", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "curator_fees.curator_fee_publishers.inventory_source", "value": "", "type": "query", "description": "Filter for records that have the specified inventory_source on a curator_fees.curator_fee_publishers association" }, { "name": "curator_fees.curator_fee_publishers.publisher", "value": "", "type": "query", "description": "Filter for records that have the specified publisher on a curator_fees.curator_fee_publishers association" }, { "name": "curator_fees.curator_fee_publishers.ad_source_ids", "value": "", "type": "query" }, { "name": "marketplace_buyers.inventory_source", "value": "", "type": "query", "description": "Filter for records that have the specified inventory_source on a marketplace_buyers association" }, { "name": "marketplace_buyers.dsp_id", "value": "", "type": "query", "description": "Filter for records that have the specified dsp_id on a marketplace_buyers association" }, { "name": "marketplace_buyers.buyer_id", "value": "", "type": "query", "description": "Filter for records that have the specified buyer_id on a marketplace_buyers association" } ] }, "docs": "Demand Tag Priorities" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_tags/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Creatives Tag", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/tag_creatives" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/tag_creatives", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/tag_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/tag_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/tag_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" } ] }, { "info": { "name": "Creatives Tile", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/tile_creatives" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/tile_creatives", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/tile_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/tile_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/tile_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" } ] }, { "info": { "name": "Timezones", "type": "folder" }, "items": [ { "info": { "name": "List all timezones from ActiveSupport::TimeZone", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/timezones" }, "docs": "Just a list of objects with timezone and name" } ] }, { "info": { "name": "User Accounts", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/user_accounts", "params": [ { "name": "partner_name", "value": "", "type": "query", "description": "filter based on supply partner or demand partner name" }, { "name": "label_name", "value": "", "type": "query", "description": "filter based on supply label or demand label name" } ] }, "docs": "For sorting in addition to regular attributes, you can also sort by `client_object_type_partner` and `client_object_type_label` which\nare whether `client_object_type='partner'` or `client_object_type='label'` respectively.\n" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/user_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/user_accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/user_accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/user_accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Bulk Update one or more attributes", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/user_accounts/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update one or more attributes" }, { "info": { "name": "Meta", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/user_accounts/meta" }, "docs": "Meta" }, { "info": { "name": "Permissions Collection", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/user_accounts/permissions" }, "docs": "Permissions Collection" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/user_accounts/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Vendors", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/vendors" }, "docs": "Index" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/vendors/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" } ] }, { "info": { "name": "Creatives Video", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/video_creatives" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/video_creatives", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/video_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/video_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/video_creatives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" } ] }, { "info": { "name": "Audiences", "type": "folder" }, "items": [ { "info": { "name": "Get paginated list of active targeted audiences", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/audiences/targeted", "params": [ { "name": "targeter_type", "value": "", "type": "query", "description": "Type of targeter. Must be provided together with `targeter_id`.\nCurrently only `DemandTag` is supported.\n" }, { "name": "targeter_id", "value": "", "type": "query", "description": "ID of the targeter. Must be provided together with `targeter_type`.\n" }, { "name": "maui_id", "value": "", "type": "query", "description": "Equality filter on the audience MAUI ID." } ] }, "docs": "Returns audiences that have active targeting associations" } ] }, { "info": { "name": "Dashboards", "type": "folder" }, "items": [ { "info": { "name": "Account Summary", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/account_summary", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Account Summary" }, { "info": { "name": "Top 10 Bidder Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/bidder_accounts", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Bidder Accounts" }, { "info": { "name": "Top 10 Bidder Accounts Open Market Copy", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/bidder_accounts_open_market", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Bidder Accounts Open Market Copy" }, { "info": { "name": "Campaign Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/campaign_performance", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Campaign Performance" }, { "info": { "name": "Top 10 Campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/campaigns", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Campaigns" }, { "info": { "name": "Comparative Day Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/comparative_day_performance", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Comparative Day Performance" }, { "info": { "name": "Creative Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/creative_performance", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "line_items", "value": "", "type": "query" } ] }, "docs": "Creative Performance" }, { "info": { "name": "Day Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/day_performance", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Day Performance" }, { "info": { "name": "Top 10 Deals", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/deals", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Deals" }, { "info": { "name": "Top 10 Demand Deals", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/demand_deals", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Demand Deals" }, { "info": { "name": "Top 10 Demand Partners", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/demand_partners", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" } ] }, "docs": "Top 10 Demand Partners" }, { "info": { "name": "Top 10 Demand Tags", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/demand_tags", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Demand Tags" }, { "info": { "name": "External Bidder Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/external_bidder_performance", "params": [ { "name": "bidder_account_id", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "ortb_report", "value": "", "type": "query" } ] }, "docs": "External Bidder Performance" }, { "info": { "name": "Five Minute Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/five_minute_performance", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Five Minute Performance" }, { "info": { "name": "Hour Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/hour_performance", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Hour Performance" }, { "info": { "name": "Label Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/label_performance", "params": [ { "name": "label_type", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Label Performance" }, { "info": { "name": "Magnite SpringServe Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/magnite_streaming_performance", "params": [ { "name": "tag_type", "value": "", "type": "query" }, { "name": "supply_tag_id", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "ortb_report", "value": "", "type": "query" } ] }, "docs": "Magnite SpringServe Performance" }, { "info": { "name": "Minute Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/minute_performance", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Minute Performance" }, { "info": { "name": "Top 10 Open Market Supply Tags", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/open_market_supply_tags", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Open Market Supply Tags" }, { "info": { "name": "Partner Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/partner_performance", "params": [ { "name": "partner_type", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Partner Performance" }, { "info": { "name": "Top 10 Publishers", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/publishers", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Publishers" }, { "info": { "name": "Quality Report", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/quality_report", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Quality Report" }, { "info": { "name": "Router Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/router_performance", "params": [ { "name": "pod", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" } ] }, "docs": "Router Performance" }, { "info": { "name": "Top 10 Supply Partners", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/supply_partners", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" } ] }, "docs": "Top 10 Supply Partners" }, { "info": { "name": "Top 10 Supply Routers", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/supply_routers", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" } ] }, "docs": "Top 10 Supply Routers" }, { "info": { "name": "Top 10 Supply Tags", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/supply_tags", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "dashboard_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "metric", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" } ] }, "docs": "Top 10 Supply Tags" }, { "info": { "name": "Tag Performance", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/dashboards/tag_performance", "params": [ { "name": "date_range", "value": "", "type": "query" }, { "name": "forecast_date_range", "value": "", "type": "query" }, { "name": "interval", "value": "", "type": "query" }, { "name": "tag_type", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" } ] }, "docs": "Tag Performance" } ] }, { "info": { "name": "Notifications", "type": "folder" }, "items": [ { "info": { "name": "Get account notifications", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/notifications/account" }, "docs": "Get notifications for current account of current user" }, { "info": { "name": "Get users notification", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/notifications/user", "params": [ { "name": "include_read", "value": "", "type": "query" } ] }, "docs": "Get notifications for current user" }, { "info": { "name": "Mark all user notifications as read", "type": "http" }, "http": { "method": "PUT", "url": "https://console.springserve.com/api/v1/notifications/user/mark-read" }, "docs": "Mark all user notifications as read" }, { "info": { "name": "Mark all user notifications as unread", "type": "http" }, "http": { "method": "PUT", "url": "https://console.springserve.com/api/v1/notifications/user/mark-unread" }, "docs": "Mark all user notifications as unread" }, { "info": { "name": "Get user notification by ID", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/notifications/user/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get notification by notification ID" }, { "info": { "name": "Mark user notification as read", "type": "http" }, "http": { "method": "PUT", "url": "https://console.springserve.com/api/v1/notifications/user/:id/mark-read", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Mark user notification with given ID as read" }, { "info": { "name": "Mark user notification as unread", "type": "http" }, "http": { "method": "PUT", "url": "https://console.springserve.com/api/v1/notifications/user/:id/mark-unread", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Mark user notification with given ID as unread" } ] }, { "info": { "name": "Report Templates", "type": "folder" }, "items": [ { "info": { "name": "Index", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/reports/templates" }, "docs": "Index" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/reports/templates", "body": { "type": "json", "data": "{}" } }, "docs": "Create" }, { "info": { "name": "Show", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/reports/templates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Show" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/reports/templates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "NOTE: This operation will overwrite and/or delete already existing parameters in the report template. Make sure\nthat everything that should be in the report template is specified in the request body.\n" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://console.springserve.com/api/v1/reports/templates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Set as default", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/reports/templates/:id/set_default", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Sets the authenticated user's default report template to this template.\n" } ] }, { "info": { "name": "Run As", "type": "folder" }, "items": [ { "info": { "name": "Available Users for Run As. Run in the context of the true user", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/run_as/available_users", "params": [ { "name": "search", "value": "", "type": "query", "description": "Search term to filter users by email" } ] }, "docs": "Lists the users that the current user can run as" }, { "info": { "name": "Can Run As User. Run in the context of the true user.", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/run_as/permission" }, "docs": "Check if the current user can run as another user" }, { "info": { "name": "Run As User. Run in the context of the true user.", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/run_as/start", "body": { "type": "json", "data": "{}" } }, "docs": "Run As User. Run in the context of the true user." }, { "info": { "name": "Stop Running As User", "type": "http" }, "http": { "method": "POST", "url": "https://console.springserve.com/api/v1/run_as/stop" }, "docs": "Stop Running As User" } ] }, { "info": { "name": "Supply Routers", "type": "folder" }, "items": [ { "info": { "name": "Download CSV", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/supply_routers/download", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of router IDs, or array of router IDs" }, { "name": "filename", "value": "", "type": "query", "description": "Optional custom filename for the CSV download" } ] }, "docs": "Download a CSV file with supply router information for the specified router IDs" } ] }, { "info": { "name": "System Settings", "type": "folder" }, "items": [ { "info": { "name": "Permissions Collection", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/system_settings/permissions" }, "docs": "Permissions Collection" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/system_settings/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Account Managers", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/users/account_managers" }, "docs": "Get the list of users that can be account managers, which is the query `all_accounts_access=true or super_admin=true`" }, { "info": { "name": "Current user", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/users/current" }, "docs": "Get information on current user" }, { "info": { "name": "Update current user", "type": "http" }, "http": { "method": "PATCH", "url": "https://console.springserve.com/api/v1/users/current", "body": { "type": "json", "data": "{}" } }, "docs": "Update current user" }, { "info": { "name": "Permissions Collection", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/users/permissions" }, "docs": "Permissions Collection" }, { "info": { "name": "Permissions Member", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/users/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Permissions Member" } ] }, { "info": { "name": "White Labels", "type": "folder" }, "items": [ { "info": { "name": "Show for Account", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/accounts/:account_id/white_label", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Show for Account" } ] }, { "info": { "name": "Magnite Programmatic", "type": "folder" }, "items": [ { "info": { "name": "Search content-targeting values from Magnite SpringServe", "type": "http" }, "http": { "method": "GET", "url": "https://console.springserve.com/api/v1/magnite_programmatic/contentMetadata/search", "params": [ { "name": "search", "value": "", "type": "query", "description": "Search query forwarded to the Magnite SpringServe API" }, { "name": "field", "value": "", "type": "query", "description": "Target field to extract from Magnite Streaming results" } ] }, "docs": "Returns content-targeting picklist values from Magnite SpringServe" } ] } ], "bundled": true }