Localization

(BETA) Users who set a language themselves.

(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty value= means no filter. No value selects the usage entry without a language.

get/api/v1/actions/organization/localization/usage/users

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Query parameters

valuestring

Language tag that the user sets.

namestring

Filter by user name, email or login (user ID). Note that the filter is case insensitive.

setting'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE'

One of LOCALE, METADATA_LOCALE and DATA_LOCALE.

source'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT'

Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.

Where the value comes from.

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned.

Response

OK

totalCountinteger required

The total number of users that match the filters.

Example response

{
  "users": [
    {
      "bySetting": {
        "DATA_LOCALE": {
          "content": {
            "value": "de-DE"
          }
        },
        "LOCALE": {
          "content": {
            "value": "de-DE"
          }
        },
        "METADATA_LOCALE": {
          "content": {
            "value": "de-DE"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.