AppSignal GraphQL API Documentation

ActionLink (object)

A link between two actions across apps via distributed tracing

ActionLinkAction (object)

An action endpoint in a distributed trace link

AggregateField (object)

A list of fields to return. Example: "fields": [ {"field": COUNT, "aggregate": SUM}, {"field": P90, "aggregate", AVG} ]

AggregationList (object)

Aggregation of metrics grouped by tags

AggregationListRow (object)

Row with grouped aggregation list data

Alert (object)

Alert triggered by metrics monitor

AlertStateChange (object)

State changes for an alert

AlertStateEnum (enum)

Possible states of an alert

AnomalyIncident (object)

Anomaly incident in which a problem or exception was reported

App (object)

An AppSignal app

Asana (object)

AsanaFormData (object)

AsanaTask (object)

AssigneeChange (object)

A record of an assignee change

BacktraceLine (object)

A single line in a backtrace

BillingCycleUsage (object)

Usage information for the current billing cycle

Breadcrumb (object)

Breadcrumb belonging to a sample

BulkTimeseries (object)

CheckIn (object)

A single check-in run

CheckInKindEnum (enum)

Kind of check-in update

CheckInStateEnum (enum)

Possible states of a check-in

CheckInTrigger (object)

A check-in trigger that monitors scheduled tasks or heartbeats

CheckInTriggerKindEnum (enum)

Kind of check-in trigger

CheckInUpdate (object)

An update event within a check-in run

CheckIns (object)

Check-in management for an app

Code (object)

CreateCsvExportPayload (object)

Autogenerated return type of CreateCsvExport.

CreateCsvExportUrlPayload (object)

Autogenerated return type of CreateCsvExportUrl.

CreateStatusPageInput (object)

Input for creating a status page

CsvExport (object)

CSV Export

CsvExportStateEnum (enum)

CustomMarker (object)

Marker with custom information

Dashboard (object)

A dashboard containing multiple visualization components

DashboardDisplayEnum (enum)

Display style for a dashboard graph

DashboardGraphInput (object)

Input for creating or updating a dashboard graph

DashboardGraphMetricInput (object)

Input for a metric within a dashboard graph

DashboardSourceEnum (enum)

Dashboard source. User created or automatically added by the system. When AppSignal detects certain metrics, language or library specific metrics, it will add a "magic" dashboard for it and related metrics.

DataInput (object)

DateTime (scalar)

UTC DateTime in ISO8601 format

DeployMarker (object)

Marker with deploy information

EditorPreference (object)

Error (object)

ErrorCause (object)

Error cause for an exception sample

Event (object)

A recorded event from a performance sample (e.g. SQL query, HTTP request)

Exception (object)

An exception with backtrace from a sample

ExceptionIncident (object)

Exception incident in which a problem or exception was reported

ExceptionIncidentQueryEnum (enum)

ExceptionSample (object)

Exception sample containing relevant sample data

Export (object)

A log export

ExportJob (object)

A log export job

ExportJobStateEnum (enum)

Possible states of a log export job

ExportJobUpdate (object)

A log export job update

ExportStateEnum (enum)

Possible states of a log export

Field (object)

A list of fields to return. Example: "fields": [ {"field": COUNT}, {"field": P90} ]

GitHub (object)

GitHubFormData (object)

GitHubIssue (object)

GitLab (object)

GitLabFormData (object)

GitLabIssue (object)

HostedCollector (object)

A hosted collector for log collection

HostedCollectorStatusEnum (enum)

Status of a hosted collector

Incident (union)

Incident objects. Can be performance, exception or log incident

Possible types: AnomalyIncident, ExceptionIncident, LogIncident, PerformanceIncident

IncidentErrorGroupingEnum (enum)

Error grouping of incident.

IncidentNotificationFrequencyEnum (enum)

IncidentOrderEnum (enum)

IncidentSeverityEnum (enum)

Severity levels for an incident

IncidentSourceEnum (enum)

The source of an incident (what generated this incident)

IncidentStateEnum (enum)

Possible states of an incident

Integration (union)

Integration objects such as GitHub, GitLab, Trello etc.

Possible types: Asana, GitHub, GitLab, Jira, Linear, Shortcut, Trello

IntegrationCreate (object)

A record of an integration being linked

JSON (scalar)

Represents untyped JSON

Jira (object)

JiraFormData (object)

JiraIssue (object)

KeyFloatValue (object)

Holds a key and a float value, used for metrics

KeyStringValue (object)

Holds a key and a value, used for metrics

KeyStringValueInput (object)

Key value hash GraphQL datastructure. Hash<String, String>

Linear (object)

LinearFormData (object)

LinearIssue (object)

Link (object)

A link between two apps via distributed tracing

LogIncident (object)

Log incident in which a problem or exception was reported

LogLine (object)

A single log line entry

LogLineAction (union)

A log line action. Can be a trigger, filter, or metrics action.

Possible types: LogLineActionFilter, LogLineActionMetrics, LogLineActionTrigger

LogLineActionFilter (object)

A log line filter action. Matches log lines and drops them.

LogLineActionMetrics (object)

A log line metrics action. Matches log lines and extracts metrics.

LogLineActionTrigger (object)

A log line trigger action. Matches log lines and generates alerts.

LogLineActionTypeEnum (enum)

LogLineMetric (object)

A metric definition extracted from matching log lines.

LogLineMetricInput (object)

LogLineMetricTypeEnum (enum)

LogLineTriggerInput (object)

Logbook (object)

Activity log for an incident or trigger

LogbookItem (union)

Logbook item objects.

Possible types: AssigneeChange, IntegrationCreate, ManualAlertStateChange, Note, NotificationFrequencyChange, NotificationThresholdChange, NotifierResult, SeverityChange, StateChange

LogbookableTypeEnum (enum)

Types that can have a logbook

Logs (object)

Log management for an app

ManualAlertStateChange (object)

A record of a manual alert state change

MarkerUnion (union)

Marker objects. Can be Deploy, Notification or Custom

Possible types: CustomMarker, DeployMarker, NotificationMarker

MetadataDistributions (object)

Distribution of metadata values across spans

MetricAggregateEnum (enum)

Fields to return in metric query

MetricAggregation (object)

Input to request a Metric List Example of an Aggegration input query: { "name": "transaction_duration", "tags": [ {"key": "action", "value": "*"}, {"key": "namespace", "value": "b"} ], "fields": [{"field": COUNT, "aggregate": SUM}] }

MetricFieldEnum (enum)

Fields to return in metric query

MetricKey (object)

Metric key extracted from timeseries data.

MetricTimeseries (object)

Input to request timeseries Metric data Example of an Aggegration input query: { "name": "transaction_duration", "tags": [ {"key": "action", "value": "*"}, {"key": "namespace", "value": "b"} ], "fields": [ { "field": COUNT }, { "field": MEAN } ] }

MetricTypeEnum (enum)

Type of metric

Metrics (object)

Holds different metric fields

Mutation (object)

The mutation root of this schema.

Namespace (object)

Namespace for an app, contains deploy markers

Note (object)

A user-created note in the logbook

NotificationFrequencyChange (object)

A record of a notification frequency change

NotificationMarker (object)

Marker with important AppSignal information

NotificationThresholdChange (object)

A record of a notification threshold change

Notifier (object)

Destination for alerts, such as Slack, Discord or Email

NotifierResult (object)

Results from notifier deliveries

Organization (object)

An AppSignal organization

PaginatedAnomalyIncidents (object)

Anomaly incidents with pagination information

PaginatedExceptionIncidents (object)

Exception incidents with pagination information

PaginatedLogIncidents (object)

Log incidents with pagination information

PaginatedPerformanceIncidents (object)

Performance incidents with pagination information

PerformanceIncident (object)

Performance incident in which a problem or exception was reported

PerformanceMarker (object)

An AppSignal incident

PerformanceSample (object)

Performance sample containing relevant sample data