Interface IReportsApiExecutor

Namespace: Crowdin.Api.Reports

Assembly: Crowdin.Api.dll

Syntax

[PublicAPI]
public interface IReportsApiExecutor

Methods

| Edit this page View Source

AddReportSettingsTemplate(long, AddReportSettingsTemplateRequest)

Declaration

Task<ReportSettingsTemplateBase> AddReportSettingsTemplate(long projectId, AddReportSettingsTemplateRequest request)

Parameters

Type	Name	Description
long	projectId
AddReportSettingsTemplateRequest	request

Returns

Type	Description
Task<ReportSettingsTemplateBase>

| Edit this page View Source

CheckGroupReportGenerationStatus(long, long)

Declaration

Task<GroupReportStatus> CheckGroupReportGenerationStatus(long groupId, long reportId)

Parameters

Type	Name	Description
long	groupId
long	reportId

Returns

Type	Description
Task<GroupReportStatus>

| Edit this page View Source

CheckOrganizationReportGenerationStatus(long)

Declaration

Task<GroupReportStatus> CheckOrganizationReportGenerationStatus(long reportId)

Parameters

Type	Name	Description
long	reportId

Returns

Type	Description
Task<GroupReportStatus>

| Edit this page View Source

CheckReportArchiveExportStatus(long?, long, string)

Declaration

Task<GroupReportStatus> CheckReportArchiveExportStatus(long? userId, long archiveId, string exportId)

Parameters

Type	Name	Description
long?	userId
long	archiveId
string	exportId

Returns

Type	Description
Task<GroupReportStatus>

| Edit this page View Source

CheckReportGenerationStatus(long, string)

Declaration

Task<ReportStatus> CheckReportGenerationStatus(long projectId, string reportId)

Parameters

Type	Name	Description
long	projectId
string	reportId

Returns

Type	Description
Task<ReportStatus>

| Edit this page View Source

DeleteReportArchive(long?, long)

Declaration

Task DeleteReportArchive(long? userId, long archiveId)

Parameters

Type	Name	Description
long?	userId
long	archiveId

Returns

Type	Description
Task

| Edit this page View Source

DeleteReportSettingsTemplate(long, long)

Declaration

Task DeleteReportSettingsTemplate(long projectId, long reportSettingsTemplateId)

Parameters

Type	Name	Description
long	projectId
long	reportSettingsTemplateId

Returns

Type	Description
Task

| Edit this page View Source

DownloadGroupReport(long, long)

Declaration

Task<DownloadLink> DownloadGroupReport(long groupId, long reportId)

Parameters

Type	Name	Description
long	groupId
long	reportId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadOrganizationReport(long)

Declaration

Task<DownloadLink> DownloadOrganizationReport(long reportId)

Parameters

Type	Name	Description
long	reportId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadReport(long, string)

Declaration

Task<DownloadLink> DownloadReport(long projectId, string reportId)

Parameters

Type	Name	Description
long	projectId
string	reportId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadReportArchive(long?, long, string)

Declaration

Task<DownloadLink> DownloadReportArchive(long? userId, long archiveId, string exportId)

Parameters

Type	Name	Description
long?	userId
long	archiveId
string	exportId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

EditReportSettingsTemplate(long, long, IEnumerable<ReportSettingsTemplatePatch>)

Declaration

Task<ReportSettingsTemplateBase> EditReportSettingsTemplate(long projectId, long reportSettingsTemplateId, IEnumerable<ReportSettingsTemplatePatch> patches)

Parameters

Type	Name	Description
long	projectId
long	reportSettingsTemplateId
IEnumerable<ReportSettingsTemplatePatch>	patches

Returns

Type	Description
Task<ReportSettingsTemplateBase>

| Edit this page View Source

ExportReportArchive(long?, long, ExportReportArchiveRequest)

Declaration

Task<GroupReportStatus> ExportReportArchive(long? userId, long archiveId, ExportReportArchiveRequest request)

Parameters

Type	Name	Description
long?	userId
long	archiveId
ExportReportArchiveRequest	request

Returns

Type	Description
Task<GroupReportStatus>

| Edit this page View Source

GenerateGroupReport(long, GenerateGroupReportRequest)

Declaration

Task<GroupReportStatus> GenerateGroupReport(long groupId, GenerateGroupReportRequest request)

Parameters

Type	Name	Description
long	groupId
GenerateGroupReportRequest	request

Returns

Type	Description
Task<GroupReportStatus>

| Edit this page View Source

GenerateOrganizationReport(GenerateGroupReportRequest)

Declaration

Task<GroupReportStatus> GenerateOrganizationReport(GenerateGroupReportRequest request)

Parameters

Type	Name	Description
GenerateGroupReportRequest	request

Returns

Type	Description
Task<GroupReportStatus>

| Edit this page View Source

GenerateReport(long, GenerateReportRequest)

Declaration

Task<ReportStatus> GenerateReport(long projectId, GenerateReportRequest request)

Parameters

Type	Name	Description
long	projectId
GenerateReportRequest	request

Returns

Type	Description
Task<ReportStatus>

| Edit this page View Source

GetReportArchive(long?, long)

Declaration

Task<ReportArchive> GetReportArchive(long? userId, long archiveId)

Parameters

Type	Name	Description
long?	userId
long	archiveId

Returns

Type	Description
Task<ReportArchive>

| Edit this page View Source

GetReportSettingsTemplate(long, long)

Declaration

Task<ReportSettingsTemplateBase> GetReportSettingsTemplate(long projectId, long reportSettingsTemplateId)

Parameters

Type	Name	Description
long	projectId
long	reportSettingsTemplateId

Returns

Type	Description
Task<ReportSettingsTemplateBase>

| Edit this page View Source

ListReportArchives(long?, ScopeType?, long?, int, int)

Declaration

Task<ResponseList<ReportArchive>> ListReportArchives(long? userId, ScopeType? scopeType = null, long? scopeId = null, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long?	userId
ScopeType?	scopeType
long?	scopeId
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<ReportArchive>>

| Edit this page View Source

ListReportSettingsTemplates(long, int, int)

Declaration

Task<ResponseList<ReportSettingsTemplateBase>> ListReportSettingsTemplates(long projectId, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long	projectId
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<ReportSettingsTemplateBase>>