---
title: "The API Pulse Submit Signal"
method: POST
path: "/signals"
tags: ["Signals"]
---

# The API Pulse Submit Signal

`POST /signals`

Submits an entire signal.

## Request body

- Signal — A pulse signal.
  - `access` Access, required — Pulse of access.
    - `internal` integer, required — How many internal APIs do you produce?
    - `partner` integer, required — How many partner APIs do you produce?
    - `public` integer, required — How many public APIs do you produce?
    - `other` string — Other information (Access).
  - `authentication` Authentication, required — Pulse of authentication.
    - `basicAuth` boolean, required — Do you use BasicAuth to authenticate with APIs?
    - `keys` boolean, required — Do you use API keys to authenticate with APIs?
    - `jwt` boolean, required — HDo you use JWT to authenticate with APIs?
    - `oauth` boolean, required — Do you use OAuth to authenticate with APIs?
    - `other` string — Other information (Authentication).
  - `contracts` Contract, required — Pulse of contract.
    - `discovery` boolean, required — Do you use APIs.json for discovery?
    - `portal` boolean, required — Do you publish APIs.json to portal?
    - `repository` boolean, required — Do you publish APIs.json to repository?
    - `other` string — Other information (Contract).
  - `distribution` Distribution, required — Pulse of distribution.
    - `publicPortal` integer, required — How many public API portals do you have?
    - `internalPortal` integer — How many internal API portals do you have?
    - `gateway` integer — How many API gateways do you have?
    - `other` string — Other information (Distribution).
  - `eventDrivenApis` EventDrivenApi, required — Pulse of Event-Driven APIs.
    - `webhooksPublish` integer, required — How many Webhooks to you publish?
    - `webhooksSubscribe` integer, required — How many Webhooks to you subscribe?
    - `webSocketsProduce` integer, required — How many WebSockets to you produce?
    - `webSocketsPublish` integer, required — How many WebSockets to you publish to?
    - `webSocketsSubscribe` integer, required — How many WebSockets to you subscribe to?
    - `kafkaProduce` integer, required — How many Kafka APIs to you produce?
    - `kafkaPublish` integer, required — How many Kafka APIs to you publish to?
    - `kafkaSubscribe` integer, required — How many Kafka APIs to you subscribe to?
    - `asyncApi` boolean, required — Do you use AsyncAPI?
    - `designFirst` boolean, required — Are you design-first when producing event-driven APIs?
    - `asyncApiDocumentation` boolean, required — Do you use AsyncAPI for Generating Documentation?
    - `asyncApiMockServers` boolean, required — Do you use AsyncAPI for Generating Mock Servers?
    - `asyncApiSdks` boolean, required — Do you use AsyncAPI for Software Development Kits (SDKs)?
    - `asyncApiTesting` boolean, required — Do you use AsyncAPI for Testing?
    - `asyncApiSecurity` boolean, required — Do you use AsyncAPI for Security?
    - `asyncApiPortal` boolean, required — Do you publish AsyncAPI to a portal?
    - `asyncApiRespository` boolean, required — Do you publish AsyncAPI to a repository?
    - `other` string — Other information (Event-Driven APIs).
  - `experience` Experience, required — Pulse of experience.
    - `discovery` integer, required — How much of a priority is API discovery?
    - `onboarding` integer, required — How much of a priority is API onboarding?
    - `quality` integer, required — How much of a priority is API quality?
    - `reliability` integer, required — How much of a priority is API reliability?
    - `consistency` integer, required — How much of a priority is API consistency?
    - `communication` integer, required — How much of a priority is API communication?
    - `automation` integer — How much of a priority is API automation?
    - `integration` integer — How much of a priority is API integration?
    - `other` string — Other information (Experience).
  - `governance` Governance, required — Pulse of API governance.
    - `spectral` boolean, required — Do you use Spectral for governance rules?
    - `vacuum` boolean, required — Do you use Vacuum for governance?
    - `design` boolean, required — Do you apply rules during design of APIs?
    - `development` boolean, required — Do you apply rules during development of APIs?
    - `pipelines` boolean, required — Do you apply rules during pipeline builds of APIs?
    - `gateway` boolean, required — Do you validate JSON Schema at the API gateway?
    - `other` string — Other information (Governance).
  - `graphQlApis` GraphQlApi, required — Pulse of GraphQL APIs.
    - `producedCount` integer, required — How many GraphQL APIs do you produce?
    - `producedPercentage` integer, required — What percentage of the APIs you produce are GraphQL?
    - `consumeCount` integer, required — How many GraphQL APIs do you consume?
    - `consumePercentage` integer, required — What percentage of the APIs you consume are GraphQL APIs?
    - `internally` boolean, required — Do you use GraphQL internally?
    - `externally` boolean, required — Do you use GraphQL externally?
    - `other` string — Other information (GraphQL APIs).
  - `httpApis` HttpApi, required — Pulse of HTTP APIs.
    - `producedCount` integer, required — How many HTTP APIs do you produce?
    - `producedPercentage` integer, required — What percentage of APIs you produce are HTTP APIs?
    - `consumeCount` integer, required — How many HTTP APIs do you consume?
    - `consumePercentage` integer, required — What percentage of APIs you consume are HTTP APIs?
    - `openApi` boolean, required — Do you use OpenAPI?
    - `designFirst` boolean, required — Are you design-first when producing HTTP APIs?
    - `openApiDocumentation` boolean, required — Do you use OpenAPI for Generating Documentation?
    - `openApiMockServers` boolean, required — Do you use OpenAPI for Generating Mock Servers?
    - `openApiSdks` boolean, required — Do you use OpenAPI for Software Development Kits (SDKs)?
    - `openApiTesting` boolean, required — Do you use OpenAPI for Testing?
    - `openApiSecurity` boolean, required — Do you use OpenAPI for Security?
    - `openApiPortal` boolean, required — Do you publish OpenAPI to a portal?
    - `openApiRespository` boolean, required — Do you publish OpenAPI to a repository?
    - `other` string — Other information (HTTP APIs).
  - `organization` Organization, required — Pulse of the organization.
    - `name` string — The company name.
    - `countries` string[] — A valid ISO 3166 country for the organization.
    - `employees` integer, required — The number of employees that work at an enterprise organization.
    - `other` string — Other information (Organization).
  - `people` People, required — Pulse of the people.
    - `name` string, required — A name.
    - `email` string, required — Valid email address.
    - `role` string, required — Role of the person.
    - `linkedIn` string — Valid LinkedIn URL.
    - `countries` string[], required — A valid ISO 3166 country for the person.
    - `other` string — Other information (People).
  - `plans` Plan, required — Pulse of API planning.
    - `applications` boolean, required — Do you require an application to be defined to access APIs?
    - `rateLimits` boolean, required — Do you enforce rate limits across all APIs?
    - `chargeAccess` boolean, required — Do you charge for access to any APIs?
    - `usage` boolean, required — Do you monitor API usage for APIs in production?
    - `report` boolean, required — Do you report on API usage data with consumers?
    - `other` string — Other information (Plan).
  - `properties` Properties, required — Pulse of API operational properties.
    - `documentation` integer, required — How much of a priority is API documentation?
    - `mockServers` integer, required — How much of a priority is API mock servers?
    - `sdks` integer, required — How much of a priority is SDKs?
    - `testing` integer, required — How much of a priority is API testing?
    - `security` integer, required — How much of a priority is API security?
    - `versioning` integer — How much of a priority is API versioning?
    - `other` string — Other information (Properties).
  - `schema` Schema, required — Pulse of schema.
    - `data` boolean, required — Do you use JSON Schema to define data?
    - `apis` boolean, required — Do you use JSON Schema to define APIs?
    - `validation` boolean, required — Do you use JSON Schema to validate data?
    - `forms` boolean, required — Do you use JSON Schema to generate forms?
    - `registry` boolean, required — Do you publish JSON Schema to registry?
    - `repository` boolean, required — Do you publish JSON Schema to repository?
    - `other` string — Other information (Schema).
  - `sector` Sector, required — Pulse of the sector.
    - `industries` string[], required — A valid North American Industry Classification System (NAICS) entry.

## Response `201`

People Pulse Submitted

- Submitted — The submitted pulse.
  - `message` string, required — The message being returned.

## Other responses

- `400` — Bad Request
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/theapipulse/apis/the-api-pulse-api-pulse-publishing.md) · [All operations](https://skmtc.net/theapipulse/apis/the-api-pulse-api-pulse-publishing/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/theapipulse/the-api-pulse-api-pulse-publishing/revisions/46e9d8a27566/schema)