SMsmartling
Reports

Get Word Count Report

Changed on

Word Count report data for the specified parameters.

get/reports-api/v3/word-count

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Query parameters

startDatestring YYYY-MM-DD required

A parameter to limit words processed on or after the startDate, in America/New_York timezone.

endDatestring YYYY-MM-DD required

A parameter to limit words processed on or before the endDate, in America/New_York timezone.

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

projectIdsProjectUid[]

Optional array of unique project identifiers. This can be found in the Smartling Dashboard under Account Settings > API.

[
  "84c012a33"
]
jobUidsTranslationJobUid[]

Optional parameter to filter to the specified list of translation jobs.

[
  "j45v1uvsi3tx"
]
agencyUidstring

Agency unique identifier — 8 lowercase hexadecimal characters.

Example:f965c52b

Optional parameter of unique agency identifier.

userUidsUserUid[]

Optional parameter to filter to the specified list of translation resources.

[
  "99b0662fbae1"
]
targetLocaleIdsLocaleId[]

Optional parameter to filter to the specified list of translation locale IDs.

[
  "fr-FR"
]
workflowStepTypesstring[]

Optional parameter to filter to the specified list of workflow step types.

The supported list of workflow step types is:

  • Translation

  • Edit

  • Review

  • Post-Edit

  • Transcreation

  • Transcreation review

  • AI Review

  • Quality Evaluation

  • LQA

  • Internal Review

  • Desktop Publishing

  • AI Translation

  • Light Post-Edit

fieldsstring

Optional comma-separated list of fields names to be returned by the endpoint. If this parameter is not set then the list of fields returned is defined by include... parameters.

Both fields and include... parameters are not allowed at the same time.

The supported list of fields names is:

  • accountUid

  • accountName

  • projectId

  • projectName

  • targetLocaleId

  • targetLocale

  • jobUid

  • jobName

  • jobReferenceNumber

  • jobNumber

  • translationResourceUid

  • translationResourceName

  • agencyUid

  • agencyName

  • workflowStepType

  • workflowStepUid

  • workflowStepName

  • fuzzyProfileName

  • fuzzyTier

  • wordCount

  • weightedWordCount

  • characterCount. Please note: the column shows correct data since 2022-10-01.

includeTranslationResourceboolean

Optional parameter to specify whether the report should group word count by translation resource name.

Deprecated, use parameter fields instead.

includeJobboolean

Optional parameter to specify whether the report should group word count by translation job name.

Deprecated, use parameter fields instead.

includeJobReferenceNumberboolean

Optional parameter to specify whether the report should group word count by translation job and include reference number in the response.

Deprecated, use parameter fields instead.

includeJobNumberboolean

Optional parameter to specify whether the report should group word count by translation job and include job number in the response.
Deprecated, use parameter fields instead.

includeFuzzyMatchProfileboolean

Optional parameter to specify whether the report should group word count by fuzzy match profile and tier.

Deprecated, use parameter fields instead.

includeWorkflowStepboolean

Optional parameter to specify whether the report should group word count by workflow step uid and name.

Deprecated, use parameter fields instead.

limitinteger

Standard Smartling limit and offset to paginate through results. Default value is 10000.

offsetinteger

Standard Smartling limit and offset to paginate through results. Default value is 0.

Response

OK

Example response

{
  "response": {
    "data": {
      "items": [
        {
          "agencyUid": "f965c52b",
          "jobUid": "j45v1uvsi3tx",
          "projectId": "84c012a33",
          "targetLocaleId": "fr-FR",
          "workflowStepUid": "7564fc097a85"
        }
      ]
    }
  }
}

Changes

  • 2cd7a8215799Revision changes
    • breaking

      added the pattern ^[a-f0-9]{8}$ to the query request parameter agencyUid

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      the ///// response's property pattern ^[a-z0-9]{12}$ was added for the status

    • info

      the ///// response's property pattern ^[a-z]{2}(-[A-Z]{2})?$ was added for the status

  • ae422098d9c5Revision changes
    • breaking

      for the query request parameter limit, default value was changed from 5000 to 10000

    • info

      added the new optional query request parameter agencyUid

    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter includeJobNumber

    • info

      added the new optional query request parameter includeJobReferenceNumber

    • info

      added the new optional query request parameter includeWorkflowStep

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter workflowStepTypes

    • info

      query request parameter includeFuzzyMatchProfile was deprecated

    • info

      query request parameter includeJob was deprecated

    • info

      query request parameter includeTranslationResource was deprecated

    • info

      for the query request parameter limit, the max was increased from 5000.00 to 10000.00

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status