openapi: 3.2.0
info:
title: VideoAmp Public Library API
version: '2026-07-31'
summary: Audience, planning, measurement and data-collaboration APIs for VideoAmp's cross-platform media measurement platform.
description: 'The VideoAmp Public API powers audience building, media planning and optimization, ad and content measurement, inventory and rate cards, data streams, and cross-organization data sharing.
**Provenance.** VideoAmp does not publish an anonymous OpenAPI document: `https://docs.videoamp.dev` redirects to Auth0 and the CLI''s `--oas` flag fetches the specification from the authenticated API. This document was derived by API Evangelist from the operation table that VideoAmp itself ships inside the official `videoamp` CLI binary (GitHub release `v0.148.32`, api_edition `2026-07-31`) — every path, method, operationId, summary, description and parameter here is reproduced verbatim from that binary''s own `--help` output. Request and response body schemas are not exposed on any anonymous surface and have deliberately been left unspecified rather than invented.
**Not an official VideoAmp artifact.** See https://docs.videoamp.dev for the authoritative specification.'
contact:
name: VideoAmp Support
email: support@videoamp.com
url: https://help.videoamp.dev
termsOfService: https://videoamp.com/terms-of-use/
servers:
- url: https://api.videoamp.dev
description: Production. The VideoAmp CLI also references `staging` and `preprod` environments (api.staging.videoamp.dev, api.preprod.videoamp.dev), but neither resolves publicly (DNS NXDOMAIN as of 2026-08-02), so they are not listed as callable servers.
security:
- videoampOAuth: []
tags:
- name: library
description: library operations.
paths:
/v1/library/conversionDataProviderOptionsSearch:
post:
operationId: datasource_conversion_provider_search
summary: Search Conversion Data Providers
tags:
- library
description: 'Searches for a list of available Conversion Data Providers for a given agency advertiser. The response includes details such as the provider''s value and label.
Please view our [help page](https://help.videoamp.dev/en/articles/11429353-datasource-options) for more information on how datasource options can be used.'
requestBody:
required: true
description: JSON request body. The CLI accepts it via `--json`. The body schema is published only in the authenticated OpenAPI document served to logged-in callers (`videoamp datasource_conversion_provider_search --oas`) and at https://docs.videoamp.dev, both of which require an Auth0 session; it is therefore not reproduced here.
content:
application/json:
schema:
type: object
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: datasource_conversion_provider_search
/v1/library/conversionGroups:
post:
operationId: conversion_group_create
summary: Create Conversion Group
tags:
- library
description: 'Creates a new Conversion Group using the provided details. A valid `data_provider_id` must be specified. The `data_provider_id` can be retrieved using the [`Search Conversion Data Providers`](/#tag/datasource-options-service/POST/v1/library/conversionDataProviderOptionsSearch) endpoint. The response returns the details of the newly created Conversion Group, including its unique identifier, metadata, and associated datasources.
Please view our [help page](https://help.videoamp.dev/en/articles/11429351-conversion-groups) for more information on how conversion groups can be used.'
parameters:
- name: validateOnly
in: query
required: false
schema:
type: boolean
description: Optional. When true, performs all validation without persisting the resource. Returns the resource with defaults applied on success. (default true)
requestBody:
required: true
description: JSON request body. The CLI accepts it via `--json`. The body schema is published only in the authenticated OpenAPI document served to logged-in callers (`videoamp conversion_group_create --oas`) and at https://docs.videoamp.dev, both of which require an Auth0 session; it is therefore not reproduced here.
content:
application/json:
schema:
type: object
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: conversion_group_create
get:
operationId: conversion_group_list
summary: List Conversion Groups
tags:
- library
description: '### What
Retrieves paginated Conversion Groups configured within your organization. Returns group metadata, datasource configurations, and conversion definitions.
### Why
Conversion Groups are required for creating outcomes Measurement reports (ADVANCED_RF_OUTCOMES, TOPLINE_LINEAR_OUTCOMES, ADVANCED_RF_OUTCOMES_SUPPLEMENTAL). Use this endpoint to discover available Conversion Groups before creating attribution analysis reports.
### When
- Discover Conversion Groups before creating outcomes Measurement reports
- Search groups by advertiser, date range, or data provider
- Audit conversion tracking configurations
- Bulk fetch specific groups by UUID
### How
Filter by `advertiserId`, `startDate`/`endDate`, `search`, `includeDataProviderId`/`excludeDataProviderId`, `currencyOfRecord`, `dataLatency`. Use `ids` for bulk fetch. Use `includeDeleted` for soft-deleted groups.
### Related Endpoints
- `GET /v1/library/conversionGroups/{id}` - Retrieve specific group
- `POST /v1/library/conversionGroups` - Create new group
- `DELETE /v1/library/conversionGroups/{id}` - Delete group
- `POST /v2beta/adMeasurements` - Create outcomes report
See [help page](https://help.videoamp.dev/en/articles/11429351-conversion-groups) for more information.'
parameters:
- name: agencyAdvertiserId
in: query
required: false
schema:
type: string
description: '**Deprecated** Optional. Ignored if advertiserId is provided. Supports multiple values via repeated query parameters.'
- name: currencyOfRecord
in: query
required: false
schema:
type: string
description: Filter by currency of record identifier. Must be combined with 'data_latency' filter. Returns groups with matching value or no currency_of_record set.
- name: dataLatency
in: query
required: false
schema:
type: string
description: 'Filter by data latency. Required when using ''currency_of_record'' filter. - DATA_LATENCY_UNSPECIFIED: No selection; Default value. - FINAL: Fully reconciled data with complete accuracy. Available 2-3 weeks after broadcast. **DSGs:** Valid when reporting_scope=AD_MEASUREMENT with KANTAR_COMMINGLE or NATIONAL_LINEAR_AND_BROADCAST_CABLE datasources; or reporting_scope=CONTENT_MEASUREMENT. **CGs:** Required when data_provider_id=linear_tune_in; not valid otherwise. - PRELIMINARY: Fast-processed data, 3-4 days after broadcast, subject to revisions. **DSGs:** Valid when reporting_scope=CONTENT_MEASUREMENT and currency_of_record supports it. **CGs:** Not valid. - NEXT_NEXT_DAY: Near real-time data, ~2 days after broadcast. Volatile. **DSGs:** Valid when reporting_scope=CONTENT_MEASUREMENT and currency_of_record supports it. **CGs:** Not valid.'
- name: endDate
in: query
required: false
schema:
type: string
description: Filter Conversion Groups by their configured date range end. Format YYYY-MM-DD (ISO 8601). When provided, returns groups where 'filter_start_date' is on or before this date, enabling discovery of groups with conversion data coverage overlapping or before this date. Can be used independently or combined with 'start_date' for complete date range filtering. Useful when creating reports for specific campaign periods to ensure returned groups have data coverage for the analysis timeframe. Validation error occurs if date format is invalid.
- name: excludeDataProviderId
in: query
required: false
schema:
type: array
items:
type: string
description: 'Excludes Conversion Groups configured with the specified data provider IDs. Supports multiple values via repeated query parameters. In addition to individual provider IDs, accepts predefined group keys that represent a set of related providers. Available group keys: streaming_tune_in (paramount_streamlog, nbcu_streamlog, tubi_streamlog). If same provider appears in both include_data_provider_id and this field, exclusion takes precedence. Use conversionDataProviderOptionsSearch endpoint to discover valid individual provider IDs.'
- name: ids
in: query
required: false
schema:
type: array
items:
type: string
description: Bulk fetch specific Conversion Groups by UUID identifiers. Format is UUID v4 for each ID. Use this for efficient batch retrieval when specific group IDs are known, avoiding filtering through large result sets. Common use case is retrieving multiple groups referenced in existing report configurations or fetching groups from saved preferences. Maximum recommended is 50 IDs per request. A user needs to have access to the IDs included for them to appear in the results.
- name: includeDataProviderId
in: query
required: false
schema:
type: array
items:
type: string
description: 'Includes only Conversion Groups configured with data provider IDs in the specified list. Supports multiple values via repeated query parameters with OR logic. In addition to individual provider IDs, accepts predefined group keys that represent a set of related providers. Available group keys: streaming_tune_in (paramount_streamlog, nbcu_streamlog, tubi_streamlog). If same provider appears in both this field and exclude_data_provider_id, exclusion takes precedence. Use conversionDataProviderOptionsSearch endpoint to discover valid individual provider IDs.'
- name: includeDeleted
in: query
required: false
schema:
type: string
description: Controls whether soft-deleted Conversion Groups appear in results. Default false returns only active non-deleted groups. Set to true to include deleted groups for auditing or historical reference. Deleted groups retain all configuration data and can be referenced in historical reports but cannot be used for new report creation. Useful for auditing, troubleshooting reports created before group deletion, or recovering configurations. Response includes deleted_at timestamp for each deleted group when true. Hard-deleted groups never appear regardless of this setting. (default true)
- name: pageSize
in: query
required: false
schema:
type: string
description: Query param pageSize specifies the number of results to include in a page of results. Defaults to 20 if not specified. Maximum allowed value is 200.
- name: pageToken
in: query
required: false
schema:
type: string
description: Query param 'pageToken' specifies the value of the next page to retrieve within a paginated set of results. Valid values can be found in paginated responses that include field 'next_page_token'. When requesting the next page, additional query parameters should NOT change between page requests.
- name: search
in: query
required: false
schema:
type: string
description: Free-text search query to filter Conversion Groups by 'display_name' field. Performs case-insensitive partial match against Conversion Group names. When omitted, no name filtering is applied and all groups matching other criteria are returned. When provided, only groups with names containing the search term as substring are included. Useful for quickly finding groups when partial name is known but not full name or ID. Search is not tokenized; entire search string is matched as phrase. Does not search other fields like 'description' or 'advertiser_name'. Combine with other filters like 'advertiserId' for precise results.
- name: startDate
in: query
required: false
schema:
type: string
description: Filter Conversion Groups by their configured date range start. Format YYYY-MM-DD (ISO 8601). When provided, returns groups where 'filter_end_date' is on or after this date, enabling discovery of groups with conversion data coverage overlapping or after this date. Can be used independently or combined with 'end_date' for complete date range filtering. Useful when creating reports for specific campaign periods to ensure returned groups have data coverage for the analysis timeframe. Validation error occurs if date format is invalid.
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: conversion_group_list
/v1/library/conversionGroups/{conversionGroupId}:
delete:
operationId: conversion_group_delete
summary: Delete Conversion Group
tags:
- library
description: 'Soft deletes a Conversion Group by its unique identifier (UUID). The resource can still be referenced by ID but will not be included in list results unless `include_deleted` is set to true.
Please view our [help page](https://help.videoamp.dev/en/articles/11429351-conversion-groups) for more information on how conversion groups can be used.'
parameters:
- name: conversionGroupId
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: conversion_group_delete
get:
operationId: conversion_group_get
summary: Get Conversion Group
tags:
- library
description: 'Retrieves complete details of a specific Conversion Group by UUID. Returns the full resource configuration including datasources with filters, lookback window settings, metadata, and timestamps. The response structure matches the format used when creating or listing Conversion Groups. Use `top_level_only=true` to retrieve metadata without datasource details for reduced response size. Use `include_deleted=true` to retrieve soft-deleted groups by ID. Do NOT use for: listing multiple groups (use GET /v1/library/conversionGroups with query parameters instead); creating new groups (use POST /v1/library/conversionGroups). Next Steps: After retrieval, use the `id` field to reference this group in subsequent API operations; examine `datasources` array to understand filter configuration; cache response client-side if displaying in UI to avoid repeated calls. Typical latency under 100ms; full datasource details (top_level_only=false, default) may add 50-100ms for groups with extensive filter configurations. See [help page](https://help.videoamp.dev/en/articles/11429351-conversion-groups) for more information on Conversion Groups.'
parameters:
- name: conversionGroupId
in: path
required: true
schema:
type: string
description: Unique identifier for the Conversion Group in standard UUID v4 format without prefix. Immutable and system-assigned when created via POST /v1/library/conversionGroups. Obtain from list operations, GET responses, or Location header of creation. Fetches complete configuration including datasources, filters, lookback window, and metadata. Required for retrieval. Returns 404 if ID nonexistent or group deleted (unless include_deleted=true). Invalid UUID format returns 400 with field validation error.
- name: includeDeleted
in: query
required: false
schema:
type: boolean
description: Enables retrieval of soft-deleted groups by ID. Default false restricts to active groups; deleted IDs return 404. True allows soft-deleted retrieval for audit trails, historical analysis, restoration. Soft-deleted groups have deleted_at timestamp, excluded from lists unless requested. Used by support investigating attribution on campaigns with deleted groups or restoring configurations. Does not affect hard-deleted groups (permanently removed). (default true)
- name: topLevelOnly
in: query
required: false
schema:
type: boolean
description: Controls datasource inclusion in response. Default false returns complete configuration with datasources array (filters, values, labels). True retrieves only metadata (id, name, lookback window, timestamps), reducing response size 60-80% and latency 50-100ms for groups with extensive filters. Use true when datasource details are not needed. (default true)
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: conversion_group_get
/v1/library/datasourceFilterNameOptionsSearch:
post:
operationId: datasource_filter_name_search
summary: Search Datasource Filter Names
tags:
- library
description: '### What
Returns available filter names by advertiser (business unit) for a given datasource type for Datasource Group (DSG) or data provider for Conversion Group (CG). Each type or provider has specific set of filter names that must be fetched from this endpoint.
### Why
Discovers which filters can be applied when building a DSG or CG.
**Business Scenarios:**
- Agent finds `network` and `daypart` filters for NATIONAL_LINEAR_BROADCAST_AND_CABLE
- User is building a CG with data provider CIRCANA and calls this endpoint to find that `pixel_id` and then `campaign_id` are available to use.
### When
Call after selecting a `datasource_type` from `POST /v1/library/datasourceTypeOptionsSearch` for a DSG. If building a CG, call after selecting a `data_provider_id` from `POST /v1/library/conversionDataProviderOptionsSearch`.
**Important:** Supports iterative narrowing via `applied_filters`. Pass previously selected filters to see remaining filter names.
**Do NOT use when:**
- You already know the exact filter names for the datasource type
- You need filter values (use `POST /v1/library/datasourceFilterValueOptionsSearch`)
**Next Steps:** Select filter names, then call `POST /v1/library/datasourceFilterValueOptionsSearch` to get values for each.
### How
**Iterative Discovery:** Call with type or provider + advertiser, select a filter name, get values via `datasourceFilterValueOptionsSearch`, call this endpoint again with `applied_filters`, repeat until done.'
requestBody:
required: true
description: JSON request body. The CLI accepts it via `--json`. The body schema is published only in the authenticated OpenAPI document served to logged-in callers (`videoamp datasource_filter_name_search --oas`) and at https://docs.videoamp.dev, both of which require an Auth0 session; it is therefore not reproduced here.
content:
application/json:
schema:
type: object
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: datasource_filter_name_search
/v1/library/datasourceFilterValueOptionsSearch:
post:
operationId: datasource_filter_value_search
summary: Search Datasource Filter Values
tags:
- library
description: '### What
Returns available filter values (e.g., pixel IDs, campaign IDs, network names) for a given datasource type and filter name. Supports text search via `search` and pagination via `page_size`/`page_token`.
### Why
Discovers specific values available for a selected filter when building a Datasource Group (DSG) or Conversion Group (CG).
**Business Scenarios:**
- Agent retrieves pixel IDs for VA_PIXEL with `datasource_filter_name=pixel_id`, uses `search` to find a specific pixel
- User browses network names for NATIONAL_LINEAR_BROADCAST_AND_CABLE, paginating through results
### When
Call after selecting a filter name from `POST /v1/library/datasourceFilterNameOptionsSearch`. Pass the same `advertiser_id`, `datasource_type`, `data_provider_id` if for CG, `reporting_scope` if for DSG, and date range.
**Important:** Returns paginated results (default 200/page). Use `search` for text filtering or `next_page_token` to iterate pages. If you have already selected values for other filters on this datasource, include them in `applied_filters` to narrow results.
**Do NOT use when:**
- You already know the exact filter values
- You need filter names (use `POST /v1/library/datasourceFilterNameOptionsSearch`)
- You need datasource types (use `POST /v1/library/datasourceTypeOptionsSearch`)
**Next Steps:** Select values, then call `POST /v1/library/datasourceFilterNameOptionsSearch` with `applied_filters` to add more filters, or `POST /v1/library/datasourceGroups` to create the DSG, or `POST /v1/library/conversionGroups` to create the CG.
### How
**Paginated Search:** Call with type + filter name + advertiser. Use `search` to text-filter, `page_token` to paginate, `applied_filters` to narrow results.'
requestBody:
required: true
description: JSON request body. The CLI accepts it via `--json`. The body schema is published only in the authenticated OpenAPI document served to logged-in callers (`videoamp datasource_filter_value_search --oas`) and at https://docs.videoamp.dev, both of which require an Auth0 session; it is therefore not reproduced here.
content:
application/json:
schema:
type: object
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: datasource_filter_value_search
/v1/library/datasourceGroups:
post:
operationId: datasource_group_create
summary: Create Datasource Group
tags:
- library
description: 'Creates a new Datasource Group using the provided details. To retrieve the `datasource_type`, use the [`Search Datasource Type Options`](/#tag/datasource-options-service/POST/v1/library/datasourceTypeOptionsSearch) endpoint. To retrieve filters, use the [`Search Datasource Filter Names`](/#tag/datasource-options-service/POST/v1/library/datasourceFilterNameOptionsSearch) and [`Search Datasource Filter Values`](/#tag/datasource-options-service/POST/v1/library/datasourceFilterValueOptionsSearch) endpoints. The response includes the details of the newly created Datasource Group, including its unique identifier, metadata, and associated datasources.
Please view our [help page](https://help.videoamp.dev/en/articles/11429358-datasource-groups-and-rules) for more information on how Datasource Groups and Datasource Group Rules are used.'
requestBody:
required: true
description: JSON request body. The CLI accepts it via `--json`. The body schema is published only in the authenticated OpenAPI document served to logged-in callers (`videoamp datasource_group_create --oas`) and at https://docs.videoamp.dev, both of which require an Auth0 session; it is therefore not reproduced here.
content:
application/json:
schema:
type: object
responses:
'200':
description: Successful response.
'401':
description: Unauthorized — missing or invalid bearer token.
x-videoamp-cli-command: datasource_group_create
get:
operationId: datasource_group_list
summary: List Datasource Groups
tags:
- library
description: '### What
Retrieves a paginated list of Datasource Groups configured within your organization. Groups define collections of Measurement Datasources with specific filters and date ranges. Response includes group metadata, Datasource configurations, ownership status, and associated advertiser information.
### Why
Datasource Groups are foundational resources that define what data gets included in Measurement reports. Before creating any Measurement report, you must first identify available Datasource Groups that contain the appropriate vendor data, date ranges, and filters for your analysis needs.
### When
Call this endpoint when you need to:
- Discover available Datasource Groups before creating Measurement reports (required prerequisite)
- Search Datasource Groups by advertiser, date range, medium, or ownership to filter available Datasources
- Audit Datasource Group configurations including currency settings, data latency, and reporting scope
### How
- Typical latency under 200ms for queries returning <100 results; pagination recommended for large result sets. Cache responses for up to 1 hour as Datasource Groups change infrequently.
- Filter by `advertiserId`, `reportingScope` (`AD_MEASUREMENT` vs `CONTENT_MEASUREMENT`), `includeMedium`/`excludeMedium` (`LINEAR`, `DIGITAL`, `SOCIAL`), `ownership` (`OWNED` vs `SHARED`), and `dataLatency` (`FINAL`, `PRELIMINARY`). Use `search` parameter to find groups by name.
### Related Endpoints
- `GET /v1/library/datasourceGroups/{id}` - Retrieve specific group details for a target ID
- `GET /v1/library/datasourceGroups/{id}/rules` - Retrieve Measurement Rules available for a Datasource Group
- `POST /v1/library/datasourceGroups` - Create a new group
- `POST /v2beta/adMeasurements` - Create a Measurement report using specific Datasource Groups
Please view our [help page](https://help.videoamp.dev/en/articles/11429358-datasource-groups-and-rules) for more information on how Datasource Groups and Datasource Group Rules are used.'
parameters:
- name: advertiserId
in: query
required: false
schema:
type: array
items:
type: string
description: Filter Datasource Groups by advertiser UUID. Supports multiple advertiser IDs via repeated query parameters to retrieve groups across multiple advertisers in a single request. Format is UUID v4. Returns only Datasource Groups associated with specified advertiser(s). Each advertiser ID must be valid UUID belonging to an advertiser your organization has access to, otherwise 403 Forbidden error occurs.
- name: agencyAdvertiserId
in: query
required: false
schema:
type: string
description: '**Deprecated** Optional. Ignored if advertiserId is provided. Supports multiple values via repeated query parameters.'
- name: currencyOfRecord
in: query
required: false
schema:
type: string
description: Filter by currency of record identifier. Must be combined with 'data_latency' filter. Returns groups with matching value or no currency_of_record set.
- name: dataLatency
in: query
required: false
schema:
type: string
description: 'Filter by data latency. Required when using ''currency_of_record'' filter. - DATA_LATENCY_UNSPECIFIED: No selection; Default value. - FINAL: Fully reconciled data with complete accuracy. Available 2-3 weeks after broadcast. **DSGs:** Valid when reporting_scope=AD_MEASUREMENT with KANTAR_COMMINGLE or NATIONAL_LINEAR_AND_BROADCAST_CABLE datasources; or reporting_scope=CONTENT_MEASUREMENT. **CGs:** Required when data_provider_id=linear_tune_in; not valid otherwise. - PRELIMINARY: Fast-processed data, 3-4 days after broadcast, subject to revisions. **DSGs:** Valid when reporting_scope=CONTENT_MEASUREMENT and currency_of_record supports it. **CGs:** Not valid. - NEXT_NEXT_DAY: Near real-time data, ~2 days after broadcast. Volatile. **DSGs:** Valid when reporting_scope=CONTENT_MEASUREMENT and currency_of_record supports it. **CGs:** Not valid.'
- name: endDate
in: query
required: false
schema:
type: string
description: 'Filter Datasource Groups using their configured ''filter_start_date'' and ''filter_end_date'' by verifying if ''[filter_start_date, filter_end_date]'' overlaps with ''[startDate, endDate]'', inclusively. Format ''YYYY-MM-DD'' (ISO 8601 date format). Used to find Datasource Groups that include data within a specific date range. Must be combined with ''startDate'' for complete date range filtering. Useful when creating reports for specific campaign periods - ensures returned groups have data coverage for your analysis timeframe. Validation error occurs if date format is invalid or if ''endDate'' is before ''startDate''. Example use case: Filter to groups covering Q1 2024 data by setting ''endDate'' to 2024-03-31.'
- name: excludeDatasourceType
in: query
required: false
schema:
type: string
description: Excludes Datasource Groups containing the specified datasource type(s). Groups with excluded types are not returned, even if they contain other types. If the same type appears in both includeDatasourceType and `excludeDatasourceType`, `excludeDatasourceType` takes precedence. Valid datasource type values can be retrieved via the `datasource_type_search` operation.
- name: excludeMedium
in: query
required: false
schema:
type: string
description: 'Excludes Datasource Groups containing the specified medium(s). Groups with excluded mediums are not returned, even if they contain other mediums. If the same medium appears in both includeMedium and `excludeMedium`, `excludeMedium` takes precedence. - LINEAR: Category for broadcast/cable TV ads. Example: `KANTAR_COMMINGLE`. - DIGITAL: Category for internet-delivered ads including from streaming, social media, websites and platforms like YouTube and Amazon. Example: `VA_PIXEL`. - SOCIAL: **Deprecated** Migrated to DIGITAL. - CROSS_SCREEN: **Rule Filters Only** Indicates a rule filter is applicable to multiple mediums.'
- name: ids
in: query
required: false
schema:
type: array
items:
type: string
description: Bulk fetch specific Datasource Groups by UUID identifiers. Optional parameter that accepts multiple Datasource Group IDs via repeated query parameters. Format is UUID v4 for each ID. Use this for efficient batch retrieval when you already know the specific group IDs you need - avoids filtering through large result sets. Common use case is retrieving multiple groups referenced in existing report configurations or fetching groups from saved user preferences. Maximum recommended is 50 IDs per request to avoid URL length limits and maintain reasonable response times. Each ID must be valid UUID - malformed IDs cause 400 Bad Request error. If an ID doesn't exist or user lacks access, it's silently omitted from results rather than causing error.
- name: includeDatasourceType
in: query
required: false
schema:
type: string
description: Includes Datasource Groups with at least one Datasource matching the specified datasource type(s). Groups may also contain other datasource types. Valid datasource type values can be retrieved via the datasource_type_search operation.
- name: includeDeleted
in: query
required: false
schema:
type: string
description: 'Controls whether soft-deleted Datasource Groups appear in results. Default false returns only active non-deleted groups. S
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/videoamp/refs/heads/main/openapi/videoamp-library-api-openapi.yml