Analyzer

`Query: analyzer` Fetch details of a single analyzer using the shortcode.

Arguments

FieldTypeDescription
shortcodeString!Shortcode of the analyzer you'd like to get.

Sample Request

query {
  analyzer(shortcode:"python") {
    id
    shortcode
    name
  }
}

Sample Response

{
  "data": {
    "analyzer": {
      "id": "QW5hbHl6Zdd6bGtiZXZ6",
      "shortcode": "python",
      "name": "Python"
    }
  }
}

analyzers

Query: analyzers Fetch all available analyzers on DeepSource.

Arguments

FieldTypeDescription
offsetIntNumber of items to skip from the beginning of the result set.
beforeStringReturns items before this cursor.
afterStringReturns items after this cursor.
firstIntReturns the first N items.
lastIntReturns the last N items.

Sample Request

query {
  analyzers{
     edges {
      node {
        id
        name
        shortcode
      }
    }
  }
}

Sample Response

{
  "data": {
    "analyzers": {
      "edges": [
        {
          "node": {
            "id": "QW5hbHl6ZXI6bGtiZXZ6",
            "name": "Python",
            "shortcode": "python"
          }
        },
        {
          "node": {
            "id": "QW5hbHl6ZXI6cmx6b2xi",
            "name": "Go",
            "shortcode": "go"
          }
        }
      ]
    }
  }
}

Objects

Analyzer

FieldTypeDescription
idID!The ID of the object.
shortcodeString!Unique identifier for this analyzer globally.
nameString!Human-friendly name for this analyzer.
versionStringVersion of the analyzer.
descriptionStringDescription of the analyzer.
typeAnalyzerType!The type of the analyzer.
metaSchemaJSONThe JSON meta schema for the analyzer configuration.
exampleConfigStringExample configuration for the analyzer.
logoStringURL of the analyzer's logo.
numIssuesIntTotal number of issues this analyzer can detect.
issueIssueFetch a specific issue by shortcode.
shortcodeString!Shortcode of the issue.
issueDistribution[IssueDistributionItem]!Distribution of issues by category.
issuesIssueConnection!All issues that this analyzer can detect.
offsetIntNumber of items to skip from the beginning of the result set.
beforeStringReturns items before this cursor.
afterStringReturns items after this cursor.
firstIntReturns the first N items.
lastIntReturns the last N items.

AnalyzerConnection

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edgesAnalyzerEdge!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.

AnalyzerEdge

A Relay edge containing a Analyzer and its cursor.

FieldTypeDescription
nodeAnalyzerThe item at the end of the edge.
cursorString!A cursor for use in pagination.

IssueDistributionItem

Distribution of issues by category for an analyzer.

FieldTypeDescription
categoryIssueCategory!The issue category.
countInt!Number of issues in this category.

On this page