Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rapidata Signal API

The Signal API from Rapidata — 7 operation(s) for signal.

Rapidata Signal API is one of 55 APIs that Rapidata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Signal. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 10 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.0.4, at version v1.

Requests are made against a single base URL, https://api.rapidata.ai/.

10 operations 7 paths 13 schemas 1 DELETE4 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
v1
Base URL
https://api.rapidata.ai/
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

Rapidata Signal API declares 1 security scheme for authenticating requests. It supports OpenID Connect (OpenIdConnect) discovered at https://auth.rapidata.ai/.well-known/openid-configuration.

  • OpenIdConnect — OpenID Connect connection flow

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Signal 10
POST
/signal
Creates a new signal.
body → 200400401403
GET
/signal
Queries the signals visible to the current caller.
13 params → 200400401403
DELETE
/signal/{signalId}
Deletes a signal by its id.
1 param → 204400401403
GET
/signal/{signalId}
Gets a signal by its id.
1 param → 200400401403
PATCH
/signal/{signalId}
Updates a signal using patch semantics.
1 param body → 204400401403
GET
/signal/run/{runId}
Gets a single signal run by its id.
1 param → 200400401403
POST
/signal/{signalId}/pause
Pauses a signal.
1 param → 204400401403
GET
/signal/{signalId}/run
Queries the runs spawned by a signal.
10 params → 200400401403
POST
/signal/{signalId}/resume
Resumes a paused signal.
1 param → 204400401403
POST
/signal/{signalId}/trigger
Manually triggers a signal.
1 param → 200400401403

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are GetSignalByIdEndpoint_Output (14 properties), QuerySignalsEndpoint_Output (14 properties), QuerySignalRunsEndpoint_Output (10 properties), GetSignalRunByIdEndpoint_Output (10 properties). Each schema is shown below with its type and property counts.

TriggerSignalEndpoint_Output
object
1 property 1 required
GetSignalByIdEndpoint_Output
object
14 properties 11 required
SignalRunTriggerSource
QuerySignalsEndpoint_PagedResultOfOutput
object
5 properties 4 required
SignalRunStatus
QuerySignalsEndpoint_Output
object
14 properties 11 required
QuerySignalRunsEndpoint_Output
object
10 properties 5 required
ValidationProblemDetails
object
6 properties
QuerySignalRunsEndpoint_PagedResultOfOutput
object
5 properties 4 required
UpdateSignalEndpoint_Input
object
3 properties
CreateSignalEndpoint_Output
object
2 properties 2 required
CreateSignalEndpoint_Input
object
7 properties 4 required
GetSignalRunByIdEndpoint_Output
object
10 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapidata-signal-api-openapi.yml Raw ↑

Other APIs Rapidata publishes across the network.

Rapidata Asset API
Rapidata Audience API
Rapidata BatchUpload API
Rapidata Benchmark API
Rapidata Billing API
Rapidata BillingAccount API
Rapidata Cache API
Rapidata Campaign API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API