ProjectAnalysisRestClient class

Package:

azure-devops-extension-api

Base class that should be used (derived from) to make requests to VSS REST apis

Extends

RestClientBase

Constructors

ProjectAnalysisRestClient(IVssRestClientOptions)

Properties

RESOURCE_AREA_ID

Methods

getGitRepositoriesActivityMetrics(string, Date, AggregationType, number, number)	Retrieves git activity metrics for repositories matching a specified criteria.
getProjectActivityMetrics(string, Date, AggregationType)
getProjectLanguageAnalytics(string)
getRepositoryActivityMetrics(string, string, Date, AggregationType)

Constructor Details

ProjectAnalysisRestClient(IVssRestClientOptions)

new ProjectAnalysisRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Property Details

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Property Value

string

Method Details

getGitRepositoriesActivityMetrics(string, Date, AggregationType, number, number)

Retrieves git activity metrics for repositories matching a specified criteria.

function getGitRepositoriesActivityMetrics(project: string, fromDate: Date, aggregationType: AggregationType, skip: number, top: number): Promise<RepositoryActivityMetrics[]>

Parameters

project

string

Project ID or project name

fromDate

Date

Date from which, the trends are to be fetched.

aggregationType

AggregationType

Bucket size on which, trends are to be aggregated.

skip

number

The number of repositories to ignore.

top

number

The number of repositories for which activity metrics are to be retrieved.

Returns

Promise<RepositoryActivityMetrics[]>

getProjectActivityMetrics(string, Date, AggregationType)

function getProjectActivityMetrics(project: string, fromDate: Date, aggregationType: AggregationType): Promise<ProjectActivityMetrics>

Parameters

project

string

Project ID or project name

fromDate

Date

aggregationType

AggregationType

Returns

Promise<ProjectActivityMetrics>

getProjectLanguageAnalytics(string)

function getProjectLanguageAnalytics(project: string): Promise<ProjectLanguageAnalytics>

Parameters

project

string

Project ID or project name

Returns

Promise<ProjectLanguageAnalytics>

getRepositoryActivityMetrics(string, string, Date, AggregationType)

function getRepositoryActivityMetrics(project: string, repositoryId: string, fromDate: Date, aggregationType: AggregationType): Promise<RepositoryActivityMetrics>

Parameters

project

string

Project ID or project name

repositoryId

string

fromDate

Date

aggregationType

AggregationType

Returns

Promise<RepositoryActivityMetrics>