masto
    Preparing search index...

    Interface FetchDimensionParams

    interface FetchDimensionParams {
        endAt?: string | null;
        instanceAccounts?: { domain?: string | null } | null;
        instanceLanguages?: { domain?: string | null } | null;
        keys: readonly (keyof DimensionKeyRegistry)[];
        limit?: string | null;
        startAt?: string | null;
        tagLanguages?: { id?: string | null } | null;
        tagServers?: { id?: string | null } | null;
    }
    Index

    Properties

    endAt? instanceAccounts? instanceLanguages? keys limit? startAt? tagLanguages? tagServers?

    Properties

    endAt?: string | null

    String (ISO 8601 Datetime). The end date for the time period. If a time is provided, it will be ignored.

    instanceAccounts?: { domain?: string | null } | null

    Type Declaration

    • { domain?: string | null }
      • Optional Readonlydomain?: string | null

        String. When instance_accounts is one of the requested keys, you must provide a domain to obtain information about popular accounts from that server.

    • null
    instanceLanguages?: { domain?: string | null } | null

    Type Declaration

    • { domain?: string | null }
      • Optional Readonlydomain?: string | null

        String. When instance_accounts is one of the requested keys, you must provide a domain to obtain information about popular languages from that server.

    • null
    keys: readonly (keyof DimensionKeyRegistry)[]

    Array of String. Request specific dimensions by their keystring. Supported dimensions include:

    • languages = Most-used languages on this server

    • sources = Most-used client apps on this server

    • servers = Remote servers with the most statuses

    • space_usage = How much space is used by your software stack

    • software_versions = The version numbers for your software stack

    • tag_servers = Most-common servers for statuses including a trending tag

    • tag_languages = Most-used languages for statuses including a trending tag

    • instance_accounts = Most-followed accounts from a remote server

    • instance_languages = Most-used languages from a remote server

    limit?: string | null

    Integer. The maximum number of results to return for sources, servers, languages, tag or instance dimensions.

    startAt?: string | null

    String (ISO 8601 Datetime). The start date for the time period. If a time is provided, it will be ignored.

    tagLanguages?: { id?: string | null } | null

    Type Declaration

    • { id?: string | null }
      • Optional Readonlyid?: string | null

        String. When tag_languages is one of the requested keys, you must provide a trending tag ID to obtain information about which languages are posting the tag.

    • null
    tagServers?: { id?: string | null } | null

    Type Declaration

    • { id?: string | null }
      • Optional Readonlyid?: string | null

        String. When tag_servers is one of the requested keys, you must provide a trending tag ID to obtain information about which servers are posting the tag.

    • null

    Settings

    Member Visibility

    On This Page

    Properties