Skip to main content

pullRequestScanRuns

Returns durable pull request scan runs for the company

pullRequestScanRuns(
companyId: ID!
pagination: BasePaginationInput!
assetIds: [ID!]
executionStates: [String!]
gateStatuses: [String!]
gateStates: [String!]
providers: [String!]
pullRequestNumber: Int
headSha: String
startedAfter: ISO8601DateTime
startedBefore: ISO8601DateTime
): PullRequestScanRunCollection!

Arguments​

pullRequestScanRuns.companyId ● ID! non-null scalar​

Company ID

pullRequestScanRuns.pagination ● BasePaginationInput! non-null input​

pullRequestScanRuns.assetIds ● [ID!] list scalar​

Restrict to these assets. Omitted, every asset the caller can see.

pullRequestScanRuns.executionStates ● [String!] list scalar​

ScanRun states: requested, enqueued, running, completed, ingested, failed, stale, lost, dlq, cancelled, superseded

pullRequestScanRuns.gateStatuses ● [String!] list scalar​

PASS, WARNING or FAIL

pullRequestScanRuns.gateStates ● [String!] list scalar​

Gate outcome: evaluated, not_configured, not_entitled, not_applicable, skipped, pending

pullRequestScanRuns.providers ● [String!] list scalar​

pullRequestScanRuns.pullRequestNumber ● Int scalar​

pullRequestScanRuns.headSha ● String scalar​

pullRequestScanRuns.startedAfter ● ISO8601DateTime scalar​

pullRequestScanRuns.startedBefore ● ISO8601DateTime scalar​

Type​

PullRequestScanRunCollection object​

PullRequestScanRunCollection type

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetPullRequestScanRuns($companyId: ID!, $pagination: BasePaginationInput!) {\n pullRequestScanRuns(companyId: $companyId, pagination: $pagination) { collection { id asset { __typename } branch { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>","pagination":{}}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute