<< Back to GForge REST API

Entity: Report

GET

getCheck

API Method. Gets the health check evaluation for the specified criteria.

Parameters (3)

Name Type Description
project int|string The ID or unixName for a single project to be scanned.
tracker int The ID for a single tracker to be scanned. If this parameter is specified, $project is ignored.
user int|string The ID or unixName for a single user to be scanned. If this parameter is specified, $project and $tracker are ignored.

Return: array

A simple array of assoc arrays, each entry representing a single health check result. Note that a single check can return multiple result records.

getDiskUsage

Gets disk usage data grouped by project and source for a project.

Parameters (2)

Name Type Description
request \RequestParameters
model \Project The project to retrieve data for.

Return: array

Disk usage breakdown by project and by source (tracker, wiki, docman, etc.).

getReport

Returns report data for a project.

Parameters (5)

Name Type Description
project string Project id or unix name. Required.
type string Report type: activity, team, tracker, disk, frs, scm, or summary. Default activity.
download string When set, returns results as a download file.
format string Download format: csv, xml, or json. Default csv.
details string Set to Y to return detailed records (used by the scm type).

Return: array

Report data for the selected type.

getScmCommitInfo

Gets SCM commit info grouped by committer and by date for a project.

Parameters (2)

Name Type Description
request \RequestParameters
model \Project The project to retrieve data for.

Return: array

Commit counts by committer and by date.

getScmDetails

Returns paginated SCM commit detail records for a project.

Parameters (1)

Name Type Description
request \RequestParameters

Return: array

Commit detail records matching the specified filters.

getSite

Returns site-wide report data. Requires site admin access.

Parameters (1)

Name Type Description
type string Report type: summary. Default summary.

Return: array

Site report data for the selected type.

getTrackersInfo

Gets tracker item counts grouped by tracker, status, assignee and submitter for a project.

Parameters (2)

Name Type Description
request \RequestParameters
model \Project The project to retrieve data for.

Return: array

Tracker item counts grouped by tracker, status, assignee, and submitter.

POST

PUT

DELETE