NerdGraph tutorial: View entity data

If you aren't sure how to start crafting an entity search query, you can rely on NerdGraph to help you build one, and then retrieve entity data and the query string that was built.

• Request the query field in your results to see the query string built by the queryBuilder argument.

• You cannot use the query and queryBuilder arguments at the same time.

• We highly recommend exploring the API using the NerdGraph GraphiQL explorer and searching its inline documentation to see the query options available to you.

  {
    actor {
      entitySearch(queryBuilder: {type: APPLICATION}) {
        query
        results {
          entities {
            reporting
            ... on AlertableEntityOutline {
              alertSeverity
            }
          }
        }
      }
    }
  }

  コピー

There are many different types of Infrastructure integration entities and they are listed separately from other entity types. Use the infrastructureIntegrationType input argument to explore them.

• You cannot use the query and queryBuilder arguments at the same time.

• Use infrastructureIntegrationType in place of the type input argument.

• We highly recommend exploring the API using the NerdGraph GraphiQL explorer and searching its inline documentation to see the query options available to you.

  {
    actor {
      entitySearch(queryBuilder: {infrastructureIntegrationType: F5_NODE}) {
        query
        results {
          entities {
            entityType
            domain
          }
        }
      }
    }
  }

  コピー

Fetch the alert severity of any entity that can be monitored by New Relic's Alerts. This NerdGraph query will tell you if we are currently receiving data from your application (using the reporting field).

• If the entity is an alertable type, results will include the alert severity of the entity.

• If the results include entities that are not alertable, they will not include the AlertableEntityOutline fields.

  {
    actor {
      entitySearch(query: "name like 'nerdgraph'") {
        results {
          entities {
            reporting
            ... on AlertableEntityOutline {
              alertSeverity
            }
          }
        }
      }
    }
  }

  コピー

Different entity types have specific data associated with them. The following NerdGraph query example shows a selection of fields available for APM application entities:

• More summary data can be requested in your query.

• If entities of other types are returned in your search results, they will not include these fields.

  {
    actor {
      entitySearch(query: "name like 'nerdgraph'") {
        results {
          entities {
            name
            ... on ApmApplicationEntityOutline {
              apmSummary {
                errorRate
                apdexScore
                webResponseTimeAverage
                responseTimeAverage
              }
            }
          }
        }
      }
    }
  }

  コピー

Different entity types have specific data associated with them. This NerdGraph query example requests the name for all entities regardless of which entity type they are, as well as the error rate for APM, browser monitoring, and mobile entities.

• If entities of other types are returned in your search results, they will not include an error rate field.

  {
    actor {
      entitySearch(query: "name like 'nerdgraph'") {
        results {
          entities {
            name
            ... on ApmApplicationEntityOutline {
              apmSummary {
                errorRate
              }
            }
            ... on BrowserApplicationEntityOutline {
              browserSummary {
                jsErrorRate
              }
            }
            ... on MobileApplicationEntityOutline {
              mobileSummary {
                httpErrorRate
              }
            }
          }
        }
      }
    }
  }

  コピー

This NerdGraph query example fetches tags for every entity returned in the search results. For more information, see the NerdGraph GraphiQL tagging tutorial.

{
  actor {
    entitySearch(query: "name like 'nerdgraph'") {
      results {
        entities {
          name
          tags {
            key
            values
          }
        }
      }
    }
  }
}

The NerdGraph GraphiQL explorer paginates results from an entity search.

• If your search criteria yields more than the API limit and you want to view the rest of the results, you can request nextCursor in your initial request and use its value in another query to retrieve the following "page" of results.

• If there are no more results, nextCursor will be null.

  {
    actor {
      entitySearch(query: "name like 'nerd-graph'") {
        results {
          nextCursor
          entities {
            name
          }
        }
      }
    }
  }

  コピー

  Use the value of nextCursor in your next search:

  {
    actor {
      entitySearch(query: "name like 'nerd-graph'") {
        results(cursor: "next_cursor_value") {
          nextCursor
          entities {
            name
          }
        }
      }
    }
  }

  コピー