Retrieve per-file code coverage data for a specific commit, branch, or pull request.
Exactly one of commit_sha, branch, or pr_number must be provided.
Optionally filter by service, codeowner, or flag (at most one).
This endpoint requires the code_coverage_read permission.
OAuth apps require the code_coverage_read authorization scope to access this endpoint.
Attributes for requesting per-file code coverage data. Exactly one of commit_sha, branch, or pr_number must be provided. At most one of service, codeowner, or flag may be provided.
branch
string
The branch name.
changed_only
boolean
When true, return coverage data only for files that were changed in the specified scope.
codeowner
string
Filter coverage by code owner. At most one of service, codeowner, or flag may be provided.
commit_sha
string
The commit SHA (40-character hexadecimal string).
flag
string
Filter coverage by coverage flag. At most one of service, codeowner, or flag may be provided.
pr_number
int64
The pull request number. Must be a positive integer.
repository_id
string
DEPRECATED: Deprecated: use repository_url instead. The repository URL.
repository_url
string
The repository URL. Accepts a full URL with or without a scheme (for example, https://github.com/org/repo or github.com/org/repo).
service
string
Filter coverage by service name. At most one of service, codeowner, or flag may be provided.
type [required]
enum
JSON:API type for files coverage request. The value must always be ci_app_coverage_files_request.
Allowed enum values: ci_app_coverage_files_request
"""
Get per-file code coverage data returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.code_coverage_apiimportCodeCoverageApifromdatadog_api_client.v2.model.files_coverage_requestimportFilesCoverageRequestfromdatadog_api_client.v2.model.files_coverage_request_attributesimportFilesCoverageRequestAttributesfromdatadog_api_client.v2.model.files_coverage_request_dataimportFilesCoverageRequestDatafromdatadog_api_client.v2.model.files_coverage_request_typeimportFilesCoverageRequestTypebody=FilesCoverageRequest(data=FilesCoverageRequestData(attributes=FilesCoverageRequestAttributes(changed_only=True,commit_sha="66adc9350f2cc9b250b69abddab733dd55e1a588",repository_url="https://github.com/datadog/shopist",),type=FilesCoverageRequestType.CI_APP_COVERAGE_FILES_REQUEST,),)configuration=Configuration()configuration.access_token=environ["DD_BEARER_TOKEN"]withApiClient(configuration)asapi_client:api_instance=CodeCoverageApi(api_client)response=api_instance.get_code_coverage_files(body=body)print(response)
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"python3"example.py"
# Get per-file code coverage data returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.access_token=ENV["DD_BEARER_TOKEN"]endapi_instance=DatadogAPIClient::V2::CodeCoverageAPI.newbody=DatadogAPIClient::V2::FilesCoverageRequest.new({data:DatadogAPIClient::V2::FilesCoverageRequestData.new({attributes:DatadogAPIClient::V2::FilesCoverageRequestAttributes.new({changed_only:true,commit_sha:"66adc9350f2cc9b250b69abddab733dd55e1a588",repository_url:"https://github.com/datadog/shopist",}),type:DatadogAPIClient::V2::FilesCoverageRequestType::CI_APP_COVERAGE_FILES_REQUEST,}),})papi_instance.get_code_coverage_files(body)
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"rb"example.rb"
// Get per-file code coverage data returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){body:=datadogV2.FilesCoverageRequest{Data:datadogV2.FilesCoverageRequestData{Attributes:datadogV2.FilesCoverageRequestAttributes{ChangedOnly:datadog.PtrBool(true),CommitSha:datadog.PtrString("66adc9350f2cc9b250b69abddab733dd55e1a588"),RepositoryUrl:datadog.PtrString("https://github.com/datadog/shopist"),},Type:datadogV2.FILESCOVERAGEREQUESTTYPE_CI_APP_COVERAGE_FILES_REQUEST,},}ctx:=datadog.NewDefaultContext(context.Background())ctx=context.WithValue(ctx,datadog.ContextAccessToken,os.Getenv("DD_BEARER_TOKEN"))configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewCodeCoverageApi(apiClient)resp,r,err:=api.GetCodeCoverageFiles(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `CodeCoverageApi.GetCodeCoverageFiles`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `CodeCoverageApi.GetCodeCoverageFiles`:\n%s\n",responseContent)}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"go run"main.go"
// Get per-file code coverage data returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.CodeCoverageApi;importcom.datadog.api.client.v2.model.FilesCoverageRequest;importcom.datadog.api.client.v2.model.FilesCoverageRequestAttributes;importcom.datadog.api.client.v2.model.FilesCoverageRequestData;importcom.datadog.api.client.v2.model.FilesCoverageRequestType;importcom.datadog.api.client.v2.model.FilesCoverageResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));CodeCoverageApiapiInstance=newCodeCoverageApi(defaultClient);FilesCoverageRequestbody=newFilesCoverageRequest().data(newFilesCoverageRequestData().attributes(newFilesCoverageRequestAttributes().changedOnly(true).commitSha("66adc9350f2cc9b250b69abddab733dd55e1a588").repositoryUrl("https://github.com/datadog/shopist")).type(FilesCoverageRequestType.CI_APP_COVERAGE_FILES_REQUEST));try{FilesCoverageResponseresult=apiInstance.getCodeCoverageFiles(body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling CodeCoverageApi#getCodeCoverageFiles");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"java"Example.java"
// Get per-file code coverage data returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_code_coverage::CodeCoverageAPI;usedatadog_api_client::datadogV2::model::FilesCoverageRequest;usedatadog_api_client::datadogV2::model::FilesCoverageRequestAttributes;usedatadog_api_client::datadogV2::model::FilesCoverageRequestData;usedatadog_api_client::datadogV2::model::FilesCoverageRequestType;#[tokio::main]asyncfnmain(){letbody=FilesCoverageRequest::new(FilesCoverageRequestData::new(FilesCoverageRequestAttributes::new().changed_only(true).commit_sha("66adc9350f2cc9b250b69abddab733dd55e1a588".to_string()).repository_url("https://github.com/datadog/shopist".to_string()),FilesCoverageRequestType::CI_APP_COVERAGE_FILES_REQUEST,));letconfiguration=datadog::Configuration::new();letapi=CodeCoverageAPI::with_config(configuration);letresp=api.get_code_coverage_files(body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get per-file code coverage data returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration({authMethods:{AuthZ:{accessToken: process.env.DD_BEARER_TOKENasstring,},},});constapiInstance=newv2.CodeCoverageApi(configuration);constparams: v2.CodeCoverageApiGetCodeCoverageFilesRequest={body:{data:{attributes:{changedOnly: true,commitSha:"66adc9350f2cc9b250b69abddab733dd55e1a588",repositoryUrl:"https://github.com/datadog/shopist",},type:"ci_app_coverage_files_request",},},};apiInstance.getCodeCoverageFiles(params).then((data: v2.FilesCoverageResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"tsc"example.ts"
Demander une démonstration personnalisée
Commencer avec Datadog
Ask AI
AI-generated responses may be inaccurate. Verify important info.