@Path(value="/stats") @Produces(value={"application/xml","application/json"}) @Consumes(value={"application/xml","application/json"}) public interface StatisticsResource extends RestResource
Modifier and Type | Field and Description |
---|---|
static String |
DATE_FORMAT |
static String |
SERVICE_PATH |
Modifier and Type | Method and Description |
---|---|
ContributionStatistics |
getContributionStatistics(String projectSlug,
String versionSlug,
String username,
String dateRange,
boolean includeAutomatedEntry)
Get contribution statistic from project-version within given date
range.
|
javax.ws.rs.core.Response |
getProjectStatisticsMatrix(String projectSlug,
String versionSlug,
String dateRangeParam,
String timeZoneID)
Return accumulated daily translation statistics including history for a
project version in given date range.
|
ContainerTranslationStatistics |
getStatistics(String projectSlug,
String iterationSlug,
boolean includeDetails,
boolean includeWordStats,
String[] locales)
Get translation statistics for a Project iteration and (optionally) it's
underlying documents.
|
ContainerTranslationStatistics |
getStatistics(String projectSlug,
String iterationSlug,
String docId,
boolean includeWordStats,
String[] locales)
Get translation statistics for a Document.
|
static final String DATE_FORMAT
static final String SERVICE_PATH
@GET @Path(value="/proj/{projectSlug}/iter/{iterationSlug}") ContainerTranslationStatistics getStatistics(@PathParam(value="projectSlug") String projectSlug, @PathParam(value="iterationSlug") String iterationSlug, @QueryParam(value="detail") @DefaultValue(value="false") boolean includeDetails, @QueryParam(value="word") @DefaultValue(value="false") boolean includeWordStats, @QueryParam(value="locale") String[] locales)
projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.includeDetails
- Indicates whether to include detailed statistics for the
project iteration's documents.includeWordStats
- Indicates whether to include word-level statistics. Default is
only message level stats.locales
- Locale statistics to be fetched. If this is empty, all locale
statistics will be returned. This parameter may be specified
multiple times if multiple locales are to be fetched.@GET @Path(value="/proj/{projectSlug}/iter/{iterationSlug}/doc/{docId:.*}") ContainerTranslationStatistics getStatistics(@PathParam(value="projectSlug") String projectSlug, @PathParam(value="iterationSlug") String iterationSlug, @PathParam(value="docId") String docId, @QueryParam(value="word") @DefaultValue(value="false") boolean includeWordStats, @QueryParam(value="locale") String[] locales)
projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.docId
- Document identifier.includeWordStats
- Indicates whether to include word-level statistics. Default is
only message level stats.locales
- Locale statistics to be fetched. If this is empty, all locale
statistics will be returned. This parameter may be specified
multiple times if multiple locales are to be fetched.@GET @Path(value="/project/{projectSlug}/version/{versionSlug}/contributor/{username}/{dateRange}") @Produces(value="application/json") ContributionStatistics getContributionStatistics(@PathParam(value="projectSlug") String projectSlug, @PathParam(value="versionSlug") String versionSlug, @PathParam(value="username") String username, @PathParam(value="dateRange") String dateRange, @QueryParam(value="includeAutomatedEntry") @DefaultValue(value="false") boolean includeAutomatedEntry)
projectSlug
- project identifierversionSlug
- version identifierusername
- username of contributordateRange
- date range from..to (yyyy-mm-dd..yyyy-mm-dd)includeAutomatedEntry
- whether to include automatic entries of translation into statistic@Path(value="project/{projectSlug}/version/{versionSlug}/{dateRangeParam}") @GET @Produces(value="application/json") javax.ws.rs.core.Response getProjectStatisticsMatrix(@PathParam(value="projectSlug") String projectSlug, @PathParam(value="versionSlug") String versionSlug, @PathParam(value="dateRangeParam") String dateRangeParam, @QueryParam(value="timeZoneID") String timeZoneID)
projectSlug
- Project identifierversionSlug
- Version identifierdateRangeParam
- from..to (yyyy-mm-dd..yyyy-mm-dd), date range maximum: 365
daystimeZoneID
- optional user time zone ID. Will use system default in absence
or GMT zone if provided time zone ID can not be understood.Copyright © 2017 Zanata Project. All rights reserved.