Upsource API Documentation Index

Messages

View as JSON

M AnalyzerStats

FieldTypeLabelDescription
minCommitTime int64 required
Unix timestamp of the earliest commit
maxCommitTime int64 required
Unix timestamp of the latest commit
totalCommits int32 required
Total number of commits
minIndexedCommitTime int64 required
Unix timestamp of the earliest indexed commit
maxIndexedCommitTime int64 required
Unix timestamp of the latest indexed commit
totalIndexedCommits int32 required
Total number of indexed commits
isProjectModelKnown bool required
Whether project model is known

M CommentsStatisticsDTO

FieldTypeLabelDescription
reviewComments int32 required
Number of review comments
totalComments int32 required
Total number of comments
totalCounts UserValue repeated
See UserValue parameters
unlabeledCounts UserValue repeated
See UserValue parameters
statsPerLabel LabelStats repeated
See LabelStats parameters

M CommitInfo

FieldTypeLabelDescription
revisionId string required
Revision ID
description string required
Commit message
time int64 required
Unix timestamp of commit time
shortRevisionId string required
Short revision ID

M CommitsDetailsDTO

FieldTypeLabelDescription
commits CommitInfo repeated
See CommitInfo parameters

M CommitsDetailsRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
fromTime int64 required
Unix timestamp
toTime int64 required
Unix timestamp
committers string repeated
User IDs of committers
module string optional
Name of the project module

M CommitsSummaryDTO

FieldTypeLabelDescription
totalCommits int32 required
Total number of commits
offsiteCommits int32 required
Number of commits that didn't affect any module
modulesTouched int32 required
Number of modules affected

M CommitsSummaryRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
fromTime int64 required
Unix timestamp
toTime int64 required
Unix timestamp
committers string repeated
User IDs of committers

M CommitterModuleValue

FieldTypeLabelDescription
committer string required
User ID of the committer
items ModuleValue repeated
See ModuleValue parameters

M CommitterTimeValue

FieldTypeLabelDescription
committer string required
User ID of the committer
items TimeValue repeated
See TimeValue parameters

M CommitterUserInfo

FieldTypeLabelDescription
committer string required
VCS committer name
userId string required
User ID of the committer

M ContributorsDistributionDTO

FieldTypeLabelDescription
items CommitterTimeValue repeated
See CommitterTimeValue parameters
timePoints int64 repeated
The specific time intervals that define the distribution
users CommitterUserInfo repeated
See CommitterUserInfo parameters

M ContributorsDistributionRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
module string optional
Name of the project module
fromTime int64 required
Unix timestamp
toTime int64 required
Unix timestamp
timePoints int64 repeated
The specific time intervals that define the distribution (Unix timestamps)

M FileHistoryChartDTO

FieldTypeLabelDescription
maxAge int64 required
Age of the oldest file on the chart (Unix timestamp)
maxEdits int32 required
Number of edits for the most edited file on the chart
paths string repeated
Full paths to the files starting with a slash (e.g. /directory/file.txt)
firstEdits int64 repeated
Unix timestamps of first edits
frames FileHistoryFrameDTO repeated
See FileHistoryFrameDTO parameters

M FileHistoryChartRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
framesCount int32 optional
Number of frames

M FileHistoryFrameDTO

FieldTypeLabelDescription
timestamp int64 required
Unix timestamp of the frame
deltas int32 repeated
Counts of file edits since the previous frame

M LabelStats

FieldTypeLabelDescription
label LabelDTO required
Discussion label. See LabelDTO parameters
countsPerUser UserValue repeated
See UserValue parameters

M ModulesDistributionDTO

FieldTypeLabelDescription
items ModuleTimeValue repeated
See ModuleTimeValue parameters
timePoints int64 repeated
The specific time intervals that define the distribution (Unix timestamps)
modules string repeated
Names of the project modules

M ModulesDistributionRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
fromTime int64 required
Unix timestamp
toTime int64 required
Unix timestamp
committers string repeated
User IDs of committers
timePoints int64 repeated
The specific time intervals that define the distribution (Unix timestamps)

M ModuleTimeValue

FieldTypeLabelDescription
module string required
Name of the project module
items TimeValue repeated
See TimeValue parameters

M ModuleValue

FieldTypeLabelDescription
module string required
Name of the project module
value int32 required
The value associated with the module

M ProjectActivityDTO

FieldTypeLabelDescription
items TimeValue repeated
See TimeValue parameters
modules string repeated
Names of project modules
stats AnalyzerStats required
See AnalyzerStats parameters

M ProjectActivityRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
module string optional
Name of the project module
referenceTime int64 required
Unix timestamp used to calculate the distribution. This timestamp encapsulates the time set on the client and makes the server generate even days, months, etc. for the particular client.

M ProjectCommittersDTO

FieldTypeLabelDescription
users CommitterUserInfo repeated
See CommitterUserInfo parameters

M ProjectPulseRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
fromTime int64 required
Unix timestamp
toTime int64 required
Unix timestamp
timePoints int64 repeated
The specific time intervals that define the distribution (Unix timestamps)

M ProjectTreeMapDTO

FieldTypeLabelDescription
entries ProjectTreeMapEntryDTO repeated
See ProjectTreeMapEntryDTO parameters

M ProjectTreeMapEntryDTO

FieldTypeLabelDescription
path string required
File path
size int32 required
File size
modificationsCount int32 required
Number of modifications
isBinary bool required
Whether a file is binary
timeSinceLastChange int64 required
Time elapsed since last change (milliseconds)

M ProjectTreeMapRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
revisionId string required
Revision ID

M PulseResponseDTO

FieldTypeLabelDescription
userValues int32 repeated
Pulse values (number of commits in a week) for the current authenticated user
allValues int32 repeated
Pulse values for all users in a project

M ResponsibilityDistributionDTO

FieldTypeLabelDescription
items CommitterModuleValue repeated
See CommitterModuleValue parameters
users CommitterUserInfo repeated
See CommitterUserInfo parameters
modules string repeated
Names of the project modules
stats AnalyzerStats required
See AnalyzerStats parameters

M ResponsibilityDistributionRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
fromTime int64 required
Unix timestamp
toTime int64 required
Unix timestamp

M ReviewCoverageDTO

FieldTypeLabelDescription
allRevisions TimeValue repeated
Number of revisions covered by reviews
revisionsCoveredByOpen TimeValue repeated
Number of revisions covered by open reviews
revisionsCoveredByClosed TimeValue repeated
Number of revisions covered by closed reviews

M ReviewCoverageRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
period TimeUnitEnum required
See TimeUnitEnum parameters
referenceTime int64 required
Unix timestamp used to calculate the distribution. This timestamp encapsulates the time set on the client and makes the server generate even days, months, etc. for the particular client.

M ReviewersGraphDTO

FieldTypeLabelDescription
userIds string repeated
User IDs of graph nodes
links ReviewersGraphLinkDTO repeated
Graph links

M ReviewersGraphLinkDTO

FieldTypeLabelDescription
from int32 required
Index of link source user
to int32 required
Index of link target user
strength int64 required
Link strength
totalReviewsCount int32 required
Total reviews count
recentReviewsCount int32 required
Recent reviews count

M ReviewersGraphRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
fromTime int64 optional
Unix timestamp, only reviews that were updated later are considered

M ReviewStatisticsDTO

FieldTypeLabelDescription
openReviews int32 required
Number of open reviews
closedReviews int32 required
Number of closed reviews
allRevisions int32 required
Number of revisions covered by reviews
revisionsCoveredByOpenReviews int32 required
Number of revisions covered by open reviews
revisionsCoveredByClosedReviews int32 required
Number of revisions covered by closed reviews
authorStatsByReviews UserValue repeated
Review counts per author
reviewerStatsByReviews UserValue repeated
Review counts per reviewer
authorStatsByRevisions UserValue repeated
Review revisions counts per author
reviewerStatsByRevisions UserValue repeated
Review revisions counts per reviewer
commentsStats CommentsStatisticsDTO required
Discussion comments statistics. See CommentsStatisticsDTO parameters

M ReviewStatisticsRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
fromTime int64 optional
Unix timestamp
toTime int64 optional
Unix timestamp

M ReviewTimeStatisticsDTO

FieldTypeLabelDescription
distribution int64 repeated
Durations of review iterations, sorted in ascending order

M ReviewTimeStatisticsRequestDTO

FieldTypeLabelDescription
userId string required
Upsource user ID

M TimeValue

A time-value pair
FieldTypeLabelDescription
time int64 required
Unix timestamp
value int32 required
The value associated with the timestamp

M UserActivityDTO

FieldTypeLabelDescription
items TimeValue repeated
See TimeValue parameters
stats AnalyzerStats required
See AnalyzerStats parameters

M UserActivityRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
period TimeUnitEnum required
User activity period. See TimeUnitEnum parameters
referenceTime int64 required
Unix timestamp used to calculate the distribution. This timestamp encapsulates the time set on the client and makes the server generate even days, months, etc. for the particular client.
committers string repeated
User IDs of committers

M UserPulseRequestDTO

FieldTypeLabelDescription
userId string required
Upsource user ID
fromTime int64 required
Unix timestamp
toTime int64 required
Unix timestamp
timePoints int64 repeated
The specific time intervals that define the distribution (Unix timestamps)

M UserValue

A user-value pair
FieldTypeLabelDescription
userId string required
Upsource user ID
value int32 required
The value associated with the user ID

Enums

View as JSON

E ReviewCoverageStateEnum

NameNumberDescription
CLOSED 1
OPEN 2
ALL 3

E TimeUnitEnum

NameNumberDescription
HOUR 1
DAY 2
WEEK 3
MONTH 4
QUARTER 5
YEAR 6