Localytics Campaigns API (1.0.0)

Download OpenAPI specification:

Localytics is an enterprise-grade mobile intelligence platform for real-time analytics, personalized marketing, and customer lifecycle optimization.

Campaign Functionality - The platform supports comprehensive campaign creation and management through this API, enabling flexible configuration of goal, scheduling, and target audience.
- Enables full campaign scheduling with A/B testing via multiple creatives, control-group weights, and advanced scheduling and delivery controls.
- Upload creative assets (HTML/Javascript/CSS assets) via API for the supporting channels (In-App, Inbox)
- Associate creatives with campaigns using standard formatting options from dashboard.
- Supported channels: Push Messaging

Push Campaigns

Requests relating to push-channel campaigns

Create a new push campaign with the given parameters. Note that campaigns with `active` status will be sent to end users upon the configured schedule with no further confirmation.

Authorizations:

BasicAuth

path Parameters

org_id required	integer The organization id found in your Dashboard containing your app.
app_id required	string The App Key which will receive this message, which can be found under the settings page of your Dashboard.

Request Body schema: application/json
required

Provide the campaign details name, status, conversion attributes, goal, creative_attributes, audiences target_rules, schedule details etc

name required	string Give any campaign name.
status required	string Enum: "active" "draft"
goal required	string Enum: "activate" "drive_behavior" "nurture" "monetize" "reengage" "notify"
	object Optional object for campaign performance tracking based upon whether receiving users later trigger this event. If undefined, then this campaign will disable conversion tracking.
required	object or object or object
required	object or object or object or object (Schedule)
required	object (CreativesAttributes)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"status": "active",
"goal": "activate",
"conversion_event": {"event_name": "string",
"conversion_attributes": {"filters": [{"dimension_name": "App Version",
"operator": "is_one_of",
"value": "string"
}
],
"operator": "and"
}
},
"audiences": {"campaign_type": "everyone",
"control_group_percent": 5,
"target_rules": {"behavior_profile_operator": "or",
"targeting_type": "install_id",
"behavior": {"days": 30,
"behavior_rule_operator": "and",
"rules": [{"count": 1,
"count_operator": "less_than",
"event_name": "string",
"rule_type": "not-event",
"conditions": {"filters": [{"dimension_name": "App Version",
"operator": "is_one_of",
"value": "string"
}
],
"operator": "or"
},
"neg_time_window": [0,
15
]
}
]
},
"profile": {"criteria": [{"key": "string",
"operator": "is_defined",
"values": ["string"
]
}
],
"operator": "and"
}
}
},
"schedule": {"begin_immediately": {"push_throttle_num_msgs": 0
},
"on_schedule": {"begin_date": "2025-08-26T04:30:00.000Z",
"starting_time_zone_id": 0,
"push_throttle_num_msgs": 0
},
"recurring": {"begin_date": "2025-08-26T04:30:00.000Z",
"end_date": "2025-08-26T04:30:00.000Z",
"starting_time_zone_id": 0,
"push_throttle_num_msgs": 0,
"frequency_attributes": [{"name": "messages_per_days",
"days": 0,
"count": 0,
"messages_atleast_days_apart": 0
}
],
"intervals": [{"interval": "weekly",
"day_of_week": "sunday",
"on_day": 0
}
]
},
"optimized": {"fallback_time": "2025-08-26T04:30:00.000Z"
}
},
"creatives": {"title": "string",
"percent": 0,
"key_values": [{"key": "string",
"value": "string"
}
],
"build_attributes": {"push_message": "string",
"push_title": "string",
"push_subtitle": "string",
"attachment_url": "https://sample.com/p/rp/859d34a70914df30.png",
"push_category": "like_dislike",
"ll_mi_deep_link_url": "https://sample.com/p/rp/859d34a70914df30.png",
"ll_deep_link_url": "yourappname://product/12345?color=red&size=large",
"sound": "string"
}
}
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"status": "active",
"goal": "activate",
"conversion_event": {"event_name": "string",
"conversion_attributes": {"filters": [{"dimension_name": "App Version",
"operator": "is_one_of",
"value": "string"
}
],
"operator": "and"
}
},
"audiences": {"campaign_type": "everyone",
"control_group_percent": 5,
"target_rules": {"behavior_profile_operator": "or",
"targeting_type": "install_id",
"behavior": {"days": 30,
"behavior_rule_operator": "and",
"rules": [{"count": 1,
"count_operator": "less_than",
"event_name": "string",
"rule_type": "not-event",
"conditions": {"filters": [{"dimension_name": "App Version",
"operator": "is_one_of",
"value": "string"
}
],
"operator": "or"
},
"neg_time_window": [0,
15
]
}
]
},
"profile": {"criteria": [{"key": "string",
"operator": "is_defined",
"values": ["string"
]
}
],
"operator": "and"
}
}
},
"schedule": {"begin_immediately": {"push_throttle_num_msgs": 0
},
"on_schedule": {"begin_date": "2025-08-26T04:30:00.000Z",
"starting_time_zone_id": 0,
"push_throttle_num_msgs": 0
},
"recurring": {"begin_date": "2025-08-26T04:30:00.000Z",
"end_date": "2025-08-26T04:30:00.000Z",
"starting_time_zone_id": 0,
"push_throttle_num_msgs": 0,
"frequency_attributes": [{"name": "messages_per_days",
"days": 0,
"count": 0,
"messages_atleast_days_apart": 0
}
],
"intervals": [{"interval": "weekly",
"interval_start": "2025-08-26T04:30:00.000Z",
"day_of_week": "sunday",
"on_day": 0
}
]
},
"optimized": {"fallback_time": "2025-08-26T04:30:00.000Z"
}
},
"creatives": {"id": 0,
"letter": "A",
"title": "string",
"percent": 0,
"key_values": [{"key": "string",
"value": "string"
}
],
"build_attributes": {"push_message": "string",
"push_title": "string",
"push_subtitle": "string",
"attachment_url": "https://sample.com/p/rp/859d34a70914df30.png",
"push_category": "like_dislike",
"ll_mi_deep_link_url": "https://sample.com/p/rp/859d34a70914df30.png",
"ll_deep_link_url": "yourappname://product/12345?color=red&size=large",
"sound": "string"
}
}
}

Get the push campaign's audience, creatives, schedule details.

Authorizations:

BasicAuth

path Parameters

org_id required	integer organization id
app_id required	string
campaign_id required	integer

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"status": "active",
"goal": "activate",
"conversion_event": {"event_name": "string",
"conversion_attributes": {"filters": [{"dimension_name": "App Version",
"operator": "is_one_of",
"value": "string"
}
],
"operator": "and"
}
},
"audiences": {"campaign_type": "everyone",
"control_group_percent": 5,
"target_rules": {"behavior_profile_operator": "or",
"targeting_type": "install_id",
"behavior": {"days": 30,
"behavior_rule_operator": "and",
"rules": [{"count": 1,
"count_operator": "less_than",
"event_name": "string",
"rule_type": "not-event",
"conditions": {"filters": [{"dimension_name": "App Version",
"operator": "is_one_of",
"value": "string"
}
],
"operator": "or"
},
"neg_time_window": [0,
15
]
}
]
},
"profile": {"criteria": [{"key": "string",
"operator": "is_defined",
"values": ["string"
]
}
],
"operator": "and"
}
}
},
"schedule": {"begin_immediately": {"push_throttle_num_msgs": 0
},
"on_schedule": {"begin_date": "2025-08-26T04:30:00.000Z",
"starting_time_zone_id": 0,
"push_throttle_num_msgs": 0
},
"recurring": {"begin_date": "2025-08-26T04:30:00.000Z",
"end_date": "2025-08-26T04:30:00.000Z",
"starting_time_zone_id": 0,
"push_throttle_num_msgs": 0,
"frequency_attributes": [{"name": "messages_per_days",
"days": 0,
"count": 0,
"messages_atleast_days_apart": 0
}
],
"intervals": [{"interval": "weekly",
"interval_start": "2025-08-26T04:30:00.000Z",
"day_of_week": "sunday",
"on_day": 0
}
]
},
"optimized": {"fallback_time": "2025-08-26T04:30:00.000Z"
}
},
"creatives": {"id": 0,
"letter": "A",
"title": "string",
"percent": 0,
"key_values": [{"key": "string",
"value": "string"
}
],
"build_attributes": {"push_message": "string",
"push_title": "string",
"push_subtitle": "string",
"attachment_url": "https://sample.com/p/rp/859d34a70914df30.png",
"push_category": "like_dislike",
"ll_mi_deep_link_url": "https://sample.com/p/rp/859d34a70914df30.png",
"ll_deep_link_url": "yourappname://product/12345?color=red&size=large",
"sound": "string"
}
}
}

Archive the push campaign.

Authorizations:

BasicAuth

path Parameters

org_id required	integer organization id
app_id required	string
campaign_id required	integer

Localytics Campaigns API (1.0.0)

Push Campaigns

Create a new push campaign with the given parameters. Note that campaigns with `active` status will be sent to end users upon the configured schedule with no further confirmation.

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get the push campaign's audience, creatives, schedule details.

Authorizations:

path Parameters

Responses

Response samples

Archive the push campaign.

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required