Reports

Export Word Count in CSV format

Changed on

Export Word Count report in CSV format.

get/reports-api/v3/word-count/csv

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.

Response

OK

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

    • info

      api operation id expoertWordCountReport removed and replaced with exportWordCountReport

    • 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 workflowStepTypes

    • info

      query request parameter includeFuzzyMatchProfile was deprecated

    • info

      query request parameter includeJob was deprecated

    • info

      query request parameter includeTranslationResource was deprecated