Skip to main content
GET
Retrieve a alert by metadata key-value

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

key
string
required
Minimum string length: 1
value
string
required

Query Parameters

requireScope
enum<string>[]
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX

Response

200 - application/json

OK

scope
enum<string>
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
id
string<uuid>
required
organizationId
string
required
environment
enum<string>
required
Available options:
test,
live
status
enum<string>
required

Alert status

Available options:
new,
in_review,
report_draft,
report_validating,
report_valid,
report_invalid,
filed,
resolved,
dismissed
itemCount
integer
required
Required range: 0 <= x <= 9007199254740991
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
externalId
string

External ID

name
string

Name

Maximum string length: 255
description
string

Description

Maximum string length: 2000
metadata
object

Metadata

scopeData
object
filedAt
string<date-time> | null

Filed at

filedReportId
string<uuid> | null

Filed report ID

createdByWorkflowId
string<uuid>
tags
object[]