POST
/
v2
/
analytics
/
{userPlanConsumeAnalyticsId}
cURL
curl --request POST \
  --url https://search.tratum.com.br/v2/analytics/{userPlanConsumeAnalyticsId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "holderId": 123,
  "organizationId": 123,
  "userPlanConsumeUniqueId": 123
}'
{
  "success": true,
  "reason": "",
  "register": {
    "summary": {
      "ALL": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "ISDEFENDANT": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "RISK_PROTEST": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "EXECUTION_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "IS_ACTIVE_WITHOUT_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "PERSON_NOT_CLASSIFIED": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "ISAUTHOR": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "IS_INACTIVE_WITHOUT_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "IS_INACTIVE_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "RISK_WORKER": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "ISDEFENDANT_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "CRIMINAL_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "RISK_DEBTOR": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "PERSON_NOT_CLASSIFIED_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "RISK_EXECUTION": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "ISAUTHOR_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "IS_ACTIVE_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "WORKER_WITH_RISK": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "RISK_CRIMINAL": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      },
      "LITIGATION": {
        "vltotalProcess": "<string>",
        "totalProcess": 123
      }
    },
    "userPlanConsumeProtestSummaryId": "594c6a7d-2a05-468a-a535-594c6a7d",
    "bucketName": "bucket",
    "statusIndex": "DONE",
    "statusProtest": "INITIAL",
    "filenameFull": "30072024_180018_FULL_7658.xlsx",
    "lastUserPlanConsumeAnalytics": 7642,
    "statusReport": "DONE",
    "typePlan": "SEARCH_ANALYZER_PREMIUM_PROTEST",
    "urlTempFull": "https://s3.aws.com/bucket/xxx/ANALYTICS/xxx/30072024_180018_FULL_7658.xlsx",
    "userPlanConsumeUniqueId": 1082,
    "createdAt": "30/07/2024 14:59:18",
    "userPlanConsumeAnalyticsId": 7658,
    "folder": "xxx/ANALYTICS/xxx/",
    "urlTemp": "https://s3.aws.com/bucket/xxx/ANALYTICS/xxx/30072024_180018_7658.xlsx",
    "importantTerms": [
      ""
    ],
    "status": "DONE"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userPlanConsumeAnalyticsId
integer
required

ID da análise

Body

application/json

Corpo da requisição

The body is of type object.

Response

200
application/json

Resumo do relatório de análise premium com protesto

The response is of type object.