- Platform Overview
- Resources and Guides
-
POS Integration
-
Getting Started
-
Core Concepts
-
Integration SDK
-
Certification
-
- Order Ahead
-
Provider Enablement
-
Provider Enablement
-
Endpoints
-
Developer Endpoints
-
-
API Reference
-
Getting Started
-
v15
-
- Access Tokens
- Campaigns
- Credit Cards
- Users
- Credit
- Locations
- Payment Methods
- QR Codes
- Progress Adjustments
- Orders
- Rewards
- Gift Cards
-
-
v14
-
- Credit
- Access Tokens
- Campaigns
- Categories
- Credit Cards
- Interstitials
- Locations
- Loyalty
- Orders
- Payment Tokens
- Support Tickets
- Users
-
-
Campaigns .: Get Icon
API Reference / v15
Get a Campaign’s Icon
This endpoint redirects the client, using an HTTP 302 response and Location header, to a campaign icon of the requested dimensions.
The following dimensions (width x height) are available at 1x, 1.5x, 2x, 3x, and 4x:
- 200 x 200
- 100 x 100
- 50 x 50
- 48 x 48
- 32 x 32
- 26 x 26
Note that an Accept
header with the value image/jpg
is required for the request.
Request Endpoint
GET /v15/campaigns/:campaign_id/icon?density=1&height=100&width=100
No Authorization Required
Request Parameters
Param | Type | Required | Description |
---|---|---|---|
density |
Decimal | Yes | The effective pixel density of the desired image, corresponding to the widespread “@1x”, “@1.5x”, “@2x” convention. Accepted values: 1, 1.5, 2, 3, 4. |
height |
Integer | Yes | The height of the desired image in pixels. |
width |
Integer | Yes | The width of the desired image in pixels. |
cURL Example
curl -X GET -H Accept:image/jpg -H Content-Type:application/json https://api.thelevelup.com/v15/campaigns/2/icon?density=1&height=100&width=100
Example Response
If an image with the requested dimensions exists, the server will respond with HTTP 302 Found and a Location header bearing the URL to the image file, e.g.
HTTP/1.1 302 Found
Headers:
Location: https://s3.amazonaws.com/levelup/c9e16d4c66c49fa15a8b26d5eef5fb855377d178.jpg
Errors
If an image does not exist with the requested dimensions, the server will respond with:
HTTP/1.1 404 Not Found
(No response body.)