@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface CollectionList

    The created collection list

    interface CollectionList {
        list_id: string;
        name: string;
        description?: string;
        account?: AccountReference;
        base_collections?: BaseCollectionSource[];
        filters?: CollectionListFilters;
        brand?: BrandReference;
        webhook_url?: string;
        cache_duration_hours?: number;
        created_at?: string;
        updated_at?: string;
        collection_count?: number;
    }
    Index

    Properties

    list_id name description? account? base_collections? filters? brand? webhook_url? cache_duration_hours? created_at? updated_at? collection_count?

    Properties

    list_id: string

    Unique identifier for this collection list

    name: string

    Human-readable name for the list

    description?: string

    Description of the list's purpose

    account?: AccountReference
    base_collections?: BaseCollectionSource[]

    Array of collection sources to evaluate. Each entry is a discriminated union: distribution_ids (platform-independent identifiers), publisher_collections (publisher_domain + collection_ids), or publisher_genres (publisher_domain + genres). If omitted, queries the agent's entire collection database.

    filters?: CollectionListFilters
    brand?: BrandReference
    webhook_url?: string

    URL to receive notifications when the resolved list changes

    cache_duration_hours?: number

    Recommended cache duration for resolved list. Consumers should re-fetch after this period. Defaults to 168 (one week) because collection metadata changes less frequently than property metadata.

    1

    created_at?: string

    When the list was created

    date-time

    updated_at?: string

    When the list was last modified

    date-time

    collection_count?: number

    Number of collections in the resolved list (at time of last resolution)

    Settings

    Member Visibility

    On This Page

    Properties