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

NaviStone Campaigns API

Campaign management

NaviStone Campaigns API is one of 8 APIs that NaviStone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://docs.navistone.com.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://docs.navistone.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

NaviStone Campaigns API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (api-key).

  • api-key — API Key for authentication

Paths & Operations 5

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

Campaigns 5

Campaign management

POST
/api/campaigns
Create a new campaign with Creative ID
CampaignsController_create body → 201400401
GET
/api/campaigns
Get all campaigns
CampaignsController_findAll → 200401
GET
/api/campaigns/{id}
Get a campaign by ID
CampaignsController_findOne 1 param → 200401404
PATCH
/api/campaigns/{id}
Update a campaign
CampaignsController_update 1 param body → 200400401404
DELETE
/api/campaigns/{id}
Soft delete a campaign
CampaignsController_remove 1 param → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are UpdateCampaignDto (3 properties), CreateCampaignDto (3 properties). Each schema is shown below with its type and property counts.

CreateCampaignDto
object
3 properties 2 required
UpdateCampaignDto
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

navistone-campaigns-api-openapi.yml Raw ↑

Other APIs NaviStone publishes across the network.

NaviStone API Info API
NaviStone Clients API
NaviStone Domains API
NaviStone Geo Targeting API
NaviStone Health API
NaviStone Output API
NaviStone Segments API