Class ProjectAnalysisApi

constructor

• new ProjectAnalysisApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): ProjectAnalysisApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns ProjectAnalysisApi

Static ReadonlyRESOURCE_AREA_ID

getGitRepositoriesActivityMetrics

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

  Retrieves git activity metrics for repositories matching a specified criteria.

  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

• 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

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

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<ProjectLanguageAnalytics>

getRepositoryActivityMetrics

• 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>