latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-08-1011834.9 KB

46e9d8a27566

Signals

The API Pulse Submit Signal

Submits an entire signal.

post/signals

Request body

Example request

{
  "access": {
    "internal": 2500,
    "partner": 50,
    "public": 50,
    "other": "Something additional I wanted to say."
  },
  "authentication": {
    "basicAuth": true,
    "keys": true,
    "jwt": true,
    "oauth": true,
    "other": "Something additional I wanted to say."
  },
  "contracts": {
    "discovery": true,
    "portal": true,
    "repository": true,
    "other": "Something additional I wanted to say."
  },
  "distribution": {
    "publicPortal": 1,
    "internalPortal": 1,
    "gateway": 2,
    "other": "Something additional I wanted to say."
  },
  "eventDrivenApis": {
    "webhooksPublish": 500,
    "webhooksSubscribe": 25,
    "webSocketsProduce": 500,
    "webSocketsPublish": 500,
    "webSocketsSubscribe": 25,
    "kafkaProduce": 500,
    "kafkaPublish": 500,
    "kafkaSubscribe": 25,
    "asyncApi": true,
    "designFirst": true,
    "asyncApiDocumentation": true,
    "asyncApiMockServers": true,
    "asyncApiSdks": true,
    "asyncApiTesting": true,
    "asyncApiSecurity": true,
    "asyncApiPortal": true,
    "asyncApiRespository": true,
    "other": "Something additional I wanted to say."
  },
  "experience": {
    "discovery": 10,
    "onboarding": 10,
    "quality": 10,
    "reliability": 10,
    "consistency": 10,
    "communication": 10,
    "automation": 10,
    "integration": 10,
    "other": "Something additional I wanted to say."
  },
  "governance": {
    "spectral": true,
    "vacuum": true,
    "design": true,
    "development": true,
    "pipelines": true,
    "gateway": true,
    "other": "Something additional I wanted to say."
  },
  "graphQlApis": {
    "producedCount": 500,
    "producedPercentage": 50,
    "consumeCount": 25,
    "consumePercentage": 90,
    "internally": true,
    "externally": true,
    "other": "Something additional I wanted to say."
  },
  "httpApis": {
    "producedCount": 500,
    "producedPercentage": 50,
    "consumeCount": 25,
    "consumePercentage": 90,
    "openApi": true,
    "designFirst": true,
    "openApiDocumentation": true,
    "openApiMockServers": true,
    "openApiSdks": true,
    "openApiTesting": true,
    "openApiSecurity": true,
    "openApiPortal": true,
    "openApiRespository": true,
    "other": "Something additional I wanted to say."
  },
  "organization": {
    "name": "API Evangelist",
    "countries": [
      "US"
    ],
    "employees": 100,
    "other": "Something additional I wanted to say."
  },
  "people": {
    "name": "Kin Lane",
    "email": "info@apievangelist.com",
    "role": "Evangelist",
    "linkedIn": "https://www.linkedin.com/in/kinlane/",
    "countries": [
      "US"
    ],
    "other": "Something additional I wanted to say."
  },
  "plans": {
    "applications": true,
    "rateLimits": true,
    "chargeAccess": true,
    "usage": true,
    "report": true,
    "other": "Something additional I wanted to say."
  },
  "properties": {
    "documentation": 10,
    "mockServers": 10,
    "sdks": 10,
    "testing": 10,
    "security": 10,
    "versioning": 10,
    "other": "Something additional I wanted to say."
  },
  "schema": {
    "data": true,
    "apis": true,
    "validation": true,
    "forms": true,
    "registry": true,
    "repository": true,
    "other": "Something additional I wanted to say."
  },
  "sector": {
    "industries": [
      "Technology"
    ]
  }
}

Response

People Pulse Submitted

messagestring required

The message being returned.

Example response

{
  "message": "The people pulse was submitted."
}