Get organization localization coverage and usage

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/settings/localization/coverage"

{
  "revision": 1,
  "locales": [
    {
      "locale": "string",
      "enabled": true,
      "isDefault": true,
      "canDisable": true,
      "disableBlockers": [
        "default_locale"
      ],
      "canRemove": true,
      "removeBlockers": [
        "default_locale"
      ],
      "usage": {
        "activeConversations": 0,
        "totalConversations": 0,
        "visitors": 0,
        "messages": 0
      },
      "coverage": {
        "total": 0,
        "translated": 0,
        "published": 0,
        "percent": 0,
        "translatedPercent": 0
      },
      "sections": [
        {
          "key": "widget",
          "total": 0,
          "translated": 0,
          "published": 0
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Try it

Base URLAPI key

Your API key is sent directly to the Convor API from your browser and is never stored on this site.

Was this page helpful?

Get organization localization coverage and usage

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/settings/localization/coverage"

{
  "revision": 1,
  "locales": [
    {
      "locale": "string",
      "enabled": true,
      "isDefault": true,
      "canDisable": true,
      "disableBlockers": [
        "default_locale"
      ],
      "canRemove": true,
      "removeBlockers": [
        "default_locale"
      ],
      "usage": {
        "activeConversations": 0,
        "totalConversations": 0,
        "visitors": 0,
        "messages": 0
      },
      "coverage": {
        "total": 0,
        "translated": 0,
        "published": 0,
        "percent": 0,
        "translatedPercent": 0
      },
      "sections": [
        {
          "key": "widget",
          "total": 0,
          "translated": 0,
          "published": 0
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Try it

Base URLAPI key

Your API key is sent directly to the Convor API from your browser and is never stored on this site.

Was this page helpful?

Get organization localization coverage and usage

Authorization

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

Get organization localization coverage and usage

Authorization

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`