Skip to main content
Skip table of contents

Insights Data Access

Lilt Analytics API

The Lilt Analytics API enables access to Lilt data. You can use this data to get insights into the productivity of your organization.

It is designed to conform to the OData v4 standard.

Authentication

Requests are authenticated via REST API key which requires the Business plan.

Contact Info: support@lilt.com
Version: 1.0.0
BasePath: https://lilt.com/2/bi/

Methods

[ Jump to Models ]

Table of Contents

Documents

Memories

Projects

Segments

Users

Methods

Documents

GET /Documents

Access Documents data (documentsGet)

Access Documents data

Query parameters

key (required)
Query Parameter — your API key

$top (required)
Query Parameter — limits result to n items format: int32

$skip (required)
Query Parameter — excludes first n items in result format: int32

Return type
inline_response_200_3

Example data
Content-Type: application/json

{ 
"@odata.context" : "$metadata#Documents",
"value" : [ {
"numReviewedSegments" : 100,
"createdAtDate" : "2020-01-01",
"isReviewComplete" : true,
"reviewDueTime" : "20:20:20",
"numSegments" : 100,
"trgLocale" : "FR",
"translationDueTime" : "20:20:20",
"isTranslationComplete" : true,
"srcLocale" : "US",
"ID" : 1,
"trgLang" : "fr",
"createdAtDateTime" : "2020-01-01T20:20:20Z",
"reviewDueDateTime" : "2020-01-01T20:20:20Z",
"numConfirmedSegments" : 100,
"translationDueDate" : "2020-01-01",
"ProjectId" : 1,
"reviewDueDate" : "2020-01-01",
"timeElapsedMS" : 100,
"numSourceTokens" : 100,
"UserId" : 1,
"name" : "English.txt",
"numSourceTokensFromTM" : 100,
"timeElapsedReviewMS" : 100,
"createdAtTime" : "20:20:20",
"translationDueDateTime" : "2020-01-01T20:20:20Z",
"fileFormat" : "txt",
"srcLang" : "en",
"isPretranslating" : 0
}, {
"numReviewedSegments" : 100,
"createdAtDate" : "2020-01-01",
"isReviewComplete" : true,
"reviewDueTime" : "20:20:20",
"numSegments" : 100,
"trgLocale" : "FR",
"translationDueTime" : "20:20:20",
"isTranslationComplete" : true,
"srcLocale" : "US",
"ID" : 1,
"trgLang" : "fr",
"createdAtDateTime" : "2020-01-01T20:20:20Z",
"reviewDueDateTime" : "2020-01-01T20:20:20Z",
"numConfirmedSegments" : 100,
"translationDueDate" : "2020-01-01",
"ProjectId" : 1,
"reviewDueDate" : "2020-01-01",
"timeElapsedMS" : 100,
"numSourceTokens" : 100,
"UserId" : 1,
"name" : "English.txt",
"numSourceTokensFromTM" : 100,
"timeElapsedReviewMS" : 100,
"createdAtTime" : "20:20:20",
"translationDueDateTime" : "2020-01-01T20:20:20Z",
"fileFormat" : "txt",
"srcLang" : "en",
"isPretranslating" : 0
} ]
}

Produces
This API call produces the following media types according to the Acceptrequest header; the media type will be conveyed by the Content-Typeresponse header.

  • application/json

Responses
200
Documents data inline_response_200_3
400
bad request
401
unauthorized
404
not found
500
internal server error

Methods

Memories

GET /Memories

Access Memories data (memoriesGet)

Access Memories data

Query parameters

key (required)
Query Parameter — your API key

$top (required)
Query Parameter — limits result to n items format: int32

$skip (required)
Query Parameter — excludes first n items in result format: int32

Return type
inline_response_200_1

Example data
Content-Type: application/json

{ 
"@odata.context" : "$metadata#Memories",
"value" : [ {
"numSegments" : 100,
"name" : "English to French",
"ID" : 1,
"trgLang" : "fr",
"srcLang" : "en"
}, {
"numSegments" : 100,
"name" : "English to French",
"ID" : 1,
"trgLang" : "fr",
"srcLang" : "en"
} ]
}

Produces
This API call produces the following media types according to the Acceptrequest header; the media type will be conveyed by the Content-Typeresponse header.

  • application/json

Responses
200
Memories data inline_response_200_1
400
bad request
401
unauthorized
404
not found
500
internal server error

Methods

Projects

GET /Projects

Access Projects data (projectsGet)

Access Projects data

Query parameters

key (required)
Query Parameter — your API key

$top (required)
Query Parameter — limits result to n items format: int32

$skip (required)
Query Parameter — excludes first n items in result format: int32

Return type
inline_response_200_2

Example data
Content-Type: application/json

{ 
"@odata.context" : "$metadata#Projects",
"value" : [ {
"createdAtDate" : "2020-01-01",
"archivedOnDate" : "2020-01-01",
"clientName" : "Acme Company",
"isArchived" : true,
"trgLocale" : "FR",
"dueDate" : "2020-01-01",
"sampleReviewPercentage" : 25,
"srcLocale" : "US",
"ID" : 1,
"state" : "done",
"archivedOnDateTime" : "2020-01-01T20:20:20Z",
"trgLang" : "fr",
"createdAtDateTime" : "2020-01-01T20:20:20Z",
"errorRate" : 5,
"dueTime" : "20:20:20",
"numSourceTokens" : 100,
"dueDateTime" : "2020-01-01T20:20:20Z",
"UserId" : 1,
"name" : "English to French",
"numSourceTokensFromTM" : 100,
"createdAtTime" : "20:20:20",
"archivedOnTime" : "20:20:20",
"MemoryId" : 1,
"srcLang" : "en",
"isComplete" : true
}, {
"createdAtDate" : "2020-01-01",
"archivedOnDate" : "2020-01-01",
"clientName" : "Acme Company",
"isArchived" : true,
"trgLocale" : "FR",
"dueDate" : "2020-01-01",
"sampleReviewPercentage" : 25,
"srcLocale" : "US",
"ID" : 1,
"state" : "done",
"archivedOnDateTime" : "2020-01-01T20:20:20Z",
"trgLang" : "fr",
"createdAtDateTime" : "2020-01-01T20:20:20Z",
"errorRate" : 5,
"dueTime" : "20:20:20",
"numSourceTokens" : 100,
"dueDateTime" : "2020-01-01T20:20:20Z",
"UserId" : 1,
"name" : "English to French",
"numSourceTokensFromTM" : 100,
"createdAtTime" : "20:20:20",
"archivedOnTime" : "20:20:20",
"MemoryId" : 1,
"srcLang" : "en",
"isComplete" : true
} ]
}

Produces
This API call produces the following media types according to the Acceptrequest header; the media type will be conveyed by the Content-Typeresponse header.

  • application/json

Responses
200
Projects data inline_response_200_2
400
bad request
401
unauthorized
404
not found
500
internal server error

Methods

Segments

GET /Segments

Access Segments data (segmentsGet)

Access Segments data

Query parameters

key (required)
Query Parameter — your API key

$top (required)
Query Parameter — limits result to n items format: int32

$skip (required)
Query Parameter — excludes first n items in result format: int32

Return type
inline_response_200_4

Example data
Content-Type: application/json

{ 
"@odata.context" : "$metadata#Segments",
"value" : [ {
"timeConfirmedDateTime" : "2020-01-01T20:20:20Z",
"isTargetFromUser" : true,
"DocumentId" : 1,
"source" : "Breathless",
"timeConfirmedDate" : "2020-01-01",
"timeConfirmedTime" : "20:20:20",
"numTargetChars" : 100,
"isAutoPropagated" : false,
"isConfirmed" : true,
"ID" : 1,
"trgLang" : "fr",
"numTargetTokens" : 100,
"UserResourceId" : 1,
"ConfirmedByUserId" : 1,
"isTargetUploaded" : false,
"isReviewed" : true,
"target" : "À bout de souffle",
"timeElapsedMS" : 100,
"numSourceTokens" : 100,
"docOrder" : 1,
"UserId" : 1,
"ReviewedByUserId" : 1,
"timeElapsedReviewMS" : 100,
"numSourceChars" : 100,
"MemoryId" : 1,
"srcLang" : "en"
}, {
"timeConfirmedDateTime" : "2020-01-01T20:20:20Z",
"isTargetFromUser" : true,
"DocumentId" : 1,
"source" : "Breathless",
"timeConfirmedDate" : "2020-01-01",
"timeConfirmedTime" : "20:20:20",
"numTargetChars" : 100,
"isAutoPropagated" : false,
"isConfirmed" : true,
"ID" : 1,
"trgLang" : "fr",
"numTargetTokens" : 100,
"UserResourceId" : 1,
"ConfirmedByUserId" : 1,
"isTargetUploaded" : false,
"isReviewed" : true,
"target" : "À bout de souffle",
"timeElapsedMS" : 100,
"numSourceTokens" : 100,
"docOrder" : 1,
"UserId" : 1,
"ReviewedByUserId" : 1,
"timeElapsedReviewMS" : 100,
"numSourceChars" : 100,
"MemoryId" : 1,
"srcLang" : "en"
} ]
}

Produces
This API call produces the following media types according to the Acceptrequest header; the media type will be conveyed by the Content-Typeresponse header.

  • application/json

Responses
200
Segments data inline_response_200_4
400
bad request
401
unauthorized
404
not found
500
internal server error

Methods

Users

GET /Users

Access Users data (usersGet)

Access Users data

Query parameters

key (required)
Query Parameter — your API key

$top (required)
Query Parameter — limits result to n items format: int32

$skip (required)
Query Parameter — excludes first n items in result format: int32

Return type
inline_response_200

Example data
Content-Type: application/json

{ 
"@odata.context" : "$metadata#Users"
"value" : [ {
"fullName" : "Acme Company",
"ID" : 1,
"email" : "acme@company.com",
"username" : "acme"
}, {
"fullName" : "Acme Company",
"ID" : 1,
"email" : "acme@company.com",
"username" : "acme"
} ]
}

Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses
200
Users data inline_response_200
400
bad request
401
unauthorized
404
not found
500
internal server error

Models

[ Jump to Methods ]

Table of Contents

  1. Document
  2. Memory
  3. Project
  4. Segment
  5. User
  6. inline_response_200
  7. inline_response_200_1
  8. inline_response_200_2
  9. inline_response_200_3
  10. inline_response_200_4

Document

Field nameData TypeDescriptionSample value
IDint32ID (unique identifier) of the project.8583
namestringUser-visible project nameEnglish.txt
fileFormatstringThe format of the filetxt
srcLangstring2-letter ISO source language codeen
srcLocalestring2-letter source language codeEN
trgLangstring2-letter ISO target language codefr
trgLocalestring2-letter target language codeFR
clientNamestringOptional: name of the customer/companyThe Example Company
numSourceTokensint32Number of source words in the project100
numSourceTokensFromTMint32 100
numSegmentsint32The number of segments in the document*100
numConfirmedSegmentsint32The number of confirmed segments in the document*100
numReviewedSegmentsint32The number of reviewed segments in the document*75
timeElapsedMSint32 1000
timeElapsedReviewMSint32 990
createdAtDateTimedate-timeDate and time at which the document was created2019-12-18T18:38:12Z
createdAtDatedateDate at which the document was created2019-12-18
createdAtTimetimeTime at which the was created18:38:12
ProjectIdint32ID (unique identifier) of the project.1
UserIdint32ID (unique identifier) of the project creator; Foreign Key to Users table298
isPretranslatingint32*0
reviewDueDateTimeDATETIMEDate and time at which the review is due.*2020-01-01T20:20:20Z
reviewDueDateDATEDate at which the review is due.*2020-01-01
reviewDueTimeTIMETime at which the review is due.*20:20:20
translationDueDateTimedate-timeDate and time at which the translation is due.*2020-01-01T20:20:20Z
translationDueDatedateDate at which the translation is due.*2020-01-01
translationDueTimetimeTime at which the translation is due.*20:20:20
isReviewCompletebooleanIs the review complete?FALSE
isTranslationCompletebooleanIs the project complete?TRUE

Memory

Field nameData TypeDescriptionSample value
IDint32ID (unique identifier) of a Lilt memory.1
NamestringUser-specified name of the Lilt MemoryEnglish To French
srcLangstring2-letter ISO source language codeen
trgLangstring2-letter ISO target language codefr
numSegmentsint32Number of segments in Memory*100

Projects

Field nameData TypeDescriptionSample value
IDint32ID (unique identifier) of a project.1
srcLangstring2-letter ISO source language codeen
trgLangstring2-letter ISO target language codefr
namestringUser-specified name of the project*English To French
clientNamestring ACME Company
dueDateTimedate-time 2020-01-01T20:20:20Z
dueDatedate 2020-01-01
dueTimetime 20:20:20
isCompleteboolean True
isArchivedboolean False
Statestring Done
archivedOnDateTimedate-time 2020-01-01T20:20:20Z
archivedOnDatedate 2020-01-01
archivedOnTimetime 20:20:20
numSourceTokensint32 100
numSourceTokensFromTMint32 100
createdAtDateTimedate-time 2019-12-18T18:38:12Z
createdAtDatedate 2019-12-18
createdAtTimetime 18:38:12
UserIDint32 1
MemoryIDint32 1
srcLocalestring US
trgLocalestring FR
sampleReviewPercentageint32 25
errorRateint32 5

Segment

Field name Data TypeDescriptionSample value
IDint32ID (unique identifier) of a project.1
srcLangstring2-letter ISO source language codeen
trgLangstring2-letter ISO target language codefr
sourcestring Breathless
targetstring À bout de souffle
numSourceTokensint32 100
numSourceCharsint32 100
timeElapsedMSint32 100
timeElapsedReviewMS  100
numTargetTokensint32 100
numTargetCharsint32 100
docOrderint32 1
isTargetUploadedboolean False
isTargetFromUserboolean True
timeConfirmedDateTimedate-time 2020-01-01T20:20:20Z
timeConfirmedDatedate 2020-01-01
timeConfirmedTimetime 20:20:20
isCompleteboolean True
isReviewedboolean False
isAutoPropagatedboolean False
UserIDint32 1
ConfirmedByUserIDint32 2
ReviewedByUserID (optional)int32 1
DocumentIDint32 1
UserResourceIDint32 11
MemoryIDint32 1

User

Field nameData TypeDescriptionSample value
IDint32 1
emailstring j.doe@company.com
usernamestring doej
Full Namestring Jan Doe

inline_response_200

@odata.context
String
example: $metadata#Users

value
array[User]

inline_response_200_1

@odata.context
String
example: $metadata#Memories

value
array[Memory]

inline_response_200_2

@odata.context
String
example: $metadata#Projects

value
array[Project]

inline_response_200_3

@odata.context
String
example: $metadata#Documents

value
array[Document]

inline_response_200_4

@odata.context
String
example: $metadata#Segments

value
array[Segment]

Project Data Access

Project endpoints provide access to Lilt Projects, a high-level entity in the Lilt database.

A Project is an activity that represents the process of accepting source content and preparing, translating, and reviewing it into a target language in order to return localized content.

Main components:

  • One or many source files (Documents table)
  • A source to target language pair
  • A Lilt Memory (Memories table)

The documents in the project follow a simple workflow:

  1. Pre-processing: automated step to extract, segment, and apply the Memory to the source text.
  2. Translation: human translation activity, accepting or modifying the Memory suggestions.
  3. Review: human proofing activity, to verify translation quality consistency, style, tone, etc..
  4. Post-processing: automated step that reverses the effect of pre-processing and generates the target document.
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.