Skip to main content
POST
/
alerts
/
{alertId}
/
generate
Generate reports for an alert
curl --request POST \
  --url https://api.artu.ai/alerts/{alertId}/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "defaults": {
    "scopeData": {
      "MX": {
        "cnbv": {
          "organoSupervisor": "<string>",
          "claveSujetoObligado": "<string>",
          "TRANSMISOR": {
            "organoSupervisor": "<string>",
            "claveSujetoObligado": "<string>",
            "sucursal": "<string>",
            "agenteNombre": "<string>",
            "agenteApellidoPaterno": "<string>",
            "agenteApellidoMaterno": "<string>",
            "agenteRfc": "<string>",
            "agenteCurp": "<string>"
          }
        }
      }
    }
  },
  "split": {
    "strategy": "minimize",
    "maxFileSizeBytes": 0
  }
}
'
{
  "status": "<unknown>",
  "alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "validation": {
    "valid": true,
    "alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "summary": {
      "totalItems": 4503599627370495,
      "validItems": 4503599627370495,
      "invalidItems": 4503599627370495,
      "errorCount": 4503599627370495
    },
    "errors": [
      {
        "path": "<string>",
        "code": "<string>",
        "message": "<string>",
        "resourceId": "<string>",
        "itemId": "<string>",
        "label": "<string>",
        "sdkField": "<string>",
        "parentClientId": "<string>"
      }
    ]
  },
  "reports": [
    {
      "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referenceNumber": "<string>",
      "sequence": 0,
      "totalParts": 0,
      "size": 0,
      "hash": "<string>",
      "deduplicated": true
    }
  ],
  "generatedAt": "2023-11-07T05:31:56Z"
}

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

alertId
string<uuid>
required

Body

application/json
reportType
enum<string>
required
Available options:
mex.actividad-vulnerable.ari,
mex.actividad-vulnerable.avi,
mex.actividad-vulnerable.inm,
mex.actividad-vulnerable.jys,
mex.actividad-vulnerable.mjr,
mex.actividad-vulnerable.mpc,
mex.actividad-vulnerable.tsc,
mex.actividad-vulnerable.veh,
mex.cnbv.transmisor
defaults
object
split
object

Response

200 - application/json

OK

status
any
required
alertId
string<uuid>
required
validation
object
required
reports
object[]
required
generatedAt
string<date-time>
required