Localytics Campaigns API
Requests relating to all channel campaigns
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/localytics-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Localytics And Audience Campaigns API
description: "Localytics is an enterprise-grade mobile intelligence platform for real-time analytics, personalized marketing, and customer lifecycle optimization.\n\n- Campaign Functionality - The platform supports comprehensive campaign creation and management through this API, enabling flexible configuration of goal, scheduling, and target audience.\n\n * Enables full campaign scheduling with A/B testing via multiple creatives, control-group weights, and advanced scheduling and delivery controls.\n\n * Upload creative assets (HTML/Javascript/CSS assets) via API for the supporting channels (In-App, Inbox)\n\n * Associate creatives with campaigns using standard formatting options from dashboard.\n\n * Supported channels:\n Push Messaging\n"
version: 1.1.2
servers:
- url: https://dashboard.localytics.com/api/v6
security:
- BasicAuth: []
tags:
- name: Campaigns
description: Requests relating to all channel campaigns
paths:
/orgs/{org_id}/apps/{app_id}/campaigns:
get:
summary: Fetch campaigns (with filters/sort)
description: Returns a list of campaigns filtered by the given query parameters
tags:
- Campaigns
operationId: ListCampaigns
parameters:
- name: org_id
in: path
required: true
description: The organization id found in your Dashboard containing your app.
schema:
type: integer
- name: app_id
in: path
required: true
description: app id value
schema:
type: string
- name: channel
in: query
required: false
description: Comma-separated values if multiple channels. Optional filter parameter.
schema:
type: string
enum:
- push
- in-app
- inbox
- places
- name: status
in: query
required: false
description: Comma-separated values if multiple campaign statuses
schema:
type: string
enum:
- scheduled
- draft
- active
- inactive
- expired
- sent
- test
- name: sort_by
in: query
required: false
description: Column to sort by
schema:
type: string
enum:
- created_at
- name
- name: sort_order
in: query
required: false
description: Order of sorting
schema:
type: string
enum:
- asc
- desc
- name: per_page
in: query
required: false
description: Number of records per API call (100 by default)
schema:
type: integer
- name: recurring
in: query
required: false
description: '0: none and both, 1: recurring, 2: only one-time, 3: either recurring OR one-time'
schema:
type: integer
enum:
- 0
- 1
- 2
- 3
- name: is_archived
in: query
required: false
description: '0: unarchived, 1: archived'
schema:
type: integer
enum:
- 0
- 1
- name: page_number
in: query
schema:
type: integer
description: Page number for pagination
responses:
'200':
description: Successful response on listing all campaigns based on filters if any.
content:
application/json:
schema:
$ref: '#/components/schemas/ListCampaignResponse'
'404':
description: Not Found – Resource not found
'422':
description: Invalid input parameters
'500':
description: Internal Server Error
/orgs/{org_id}/apps/{app_id}/campaigns/search:
get:
summary: Search campaigns by keyword
description: Fetches campaigns by name or ID using a required key param
tags:
- Campaigns
operationId: SearchCampaigns
parameters:
- name: org_id
in: path
required: true
description: The organization id found in your Dashboard containing your app.
schema:
type: integer
- name: app_id
in: path
required: true
description: app id value
schema:
type: string
- name: key
in: query
required: true
description: Key to search by name or campaign ID
schema:
type: string
- name: channel
in: query
required: false
description: Comma-separated values if multiple channels. Optional filter parameter.
schema:
type: string
enum:
- push
- in-app
- inbox
- places
- name: status
in: query
required: false
description: Comma-separated values if multiple campaign statuses
schema:
type: string
enum:
- scheduled
- draft
- active
- inactive
- expired
- sent
- test
- error
- name: sort_by
in: query
required: false
description: Column to sort by
schema:
type: string
enum:
- created_at
- name
- name: sort_order
in: query
required: false
description: Order of sorting
schema:
type: string
enum:
- asc
- desc
- name: per_page
in: query
required: false
description: Number of records per API call (100 by default)
schema:
type: integer
- name: recurring
in: query
required: false
description: '0: none and both, 1: recurring, 2: only one-time, 3: either recurring OR one-time'
schema:
type: integer
enum:
- 0
- 1
- 2
- 3
- name: is_archived
in: query
required: false
description: '0: unarchived, 1: archived'
schema:
type: integer
enum:
- 0
- 1
- name: page_number
in: query
schema:
type: integer
description: Page number for pagination
responses:
'200':
description: Successful response on listing all campaigns based on filters if any and search key.
content:
application/json:
schema:
$ref: '#/components/schemas/ListCampaignResponse'
'404':
description: Not Found – Resource not found
'422':
description: Invalid input parameters
'500':
description: Internal Server Error
components:
schemas:
ListCampaignResponse:
type: object
properties:
app_id:
type: string
records_count:
type: integer
total_records:
type: integer
campaigns:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
message_type:
type: string
platform:
type: string
send_local_tz:
type: integer
recurring:
type: integer
begin_date:
type:
- string
- 'null'
format: date-time
end_date:
type:
- string
- 'null'
format: date-time
status:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
sends:
type: integer
open_rate:
type: string
example: 10.4%
securitySchemes:
BasicAuth:
type: http
scheme: basic