Get Campaign Details

curl --request GET \
  --url 'https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}'

const options = {method: 'GET'};

fetch('https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "company_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "status": "<string>",
  "image": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "deletedAt": "<string>",
  "associated_stores": [
    {
      "store_id": "<string>",
      "store_name": "<string>",
      "status": "<string>",
      "linked_at": "<string>"
    }
  ],
  "promotions": [
    {
      "promotion_id": "<string>",
      "code": "<string>",
      "type": "<string>",
      "status": "<string>",
      "usage_count": 123
    }
  ],
  "performance_metrics": {
    "total_views": 123,
    "total_conversions": 123,
    "conversion_rate": 123,
    "revenue_generated": "<string>",
    "average_order_value": "<string>"
  }
}

GET

{micro_service_base_url}

stores

company

{company_id}

campaigns

{campaign_id}

Get Campaign Details

curl --request GET \
  --url 'https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}'

const options = {method: 'GET'};

fetch('https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns/{{campaign_id}}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "company_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "status": "<string>",
  "image": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "deletedAt": "<string>",
  "associated_stores": [
    {
      "store_id": "<string>",
      "store_name": "<string>",
      "status": "<string>",
      "linked_at": "<string>"
    }
  ],
  "promotions": [
    {
      "promotion_id": "<string>",
      "code": "<string>",
      "type": "<string>",
      "status": "<string>",
      "usage_count": 123
    }
  ],
  "performance_metrics": {
    "total_views": 123,
    "total_conversions": 123,
    "conversion_rate": 123,
    "revenue_generated": "<string>",
    "average_order_value": "<string>"
  }
}

This endpoint provides complete details for a specific campaign, including all configuration settings, associated store information, linked promotions, and performance analytics.

This endpoint returns the most comprehensive campaign information available, ideal for campaign editing, detailed analysis, and administrative oversight.

Path Parameters

string

required

The unique identifier of the company that owns the campaign

string

required

The unique identifier of the campaign to retrieve details for

Response

string

Unique campaign identifier

string

Company identifier this campaign belongs to

string

Campaign name

string

Detailed campaign description

string

Campaign start date (YYYY-MM-DD)

string

Campaign end date (YYYY-MM-DD)

string

Current campaign status

string

URL to campaign image asset

string

ID of the user who created the campaign

string

ID of the user who last updated the campaign

string

Campaign creation timestamp

string

Campaign last update timestamp

string

Deletion timestamp (null for active campaigns)

array

List of stores linked to this campaign

Show Store Association

string

Store unique identifier

string

Store display name

string

Association status

string

Association timestamp

array

List of promotions associated with this campaign

Show Campaign Promotions

string

Promotion unique identifier

string

Promotional code

string

Promotion type

string

Promotion status

integer

Number of times used

object

Campaign performance analytics

Show Performance Data

integer

Total campaign impressions

integer

Total conversions generated

number

Conversion rate percentage

string

Total revenue attributed to campaign

string

Average order value from campaign

Example Response

Since no specific response was provided, here’s the expected comprehensive structure:

{
  "id": "1000010",
  "company_id": "1000058",
  "name": "Spring Fresh Campaign",
  "description": "Spring seasonal promotion featuring fresh products and outdoor essentials",
  "start_date": "2025-03-01",
  "end_date": "2025-05-31",
  "status": "active",
  "image": "https://lula-stores-service-staging.s3.amazonaws.com/company/1000058/campaigns/1000010/1744591882710.webp",
  "created_by": "1000418",
  "updated_by": "1000418",
  "created_at": "2025-04-14T00:51:22.994Z",
  "updated_at": "2025-04-14T00:51:22.994Z",
  "deletedAt": null,
  "associated_stores": [
    {
      "store_id": "store_001",
      "store_name": "Downtown Location",
      "status": "active",
      "linked_at": "2025-04-14T01:00:00.000Z"
    }
  ],
  "promotions": [
    {
      "promotion_id": "promo_001",
      "code": "SPRING25",
      "type": "percentage",
      "status": "active",
      "usage_count": 45
    }
  ],
  "performance_metrics": {
    "total_views": 1250,
    "total_conversions": 89,
    "conversion_rate": 7.12,
    "revenue_generated": "4,567.89",
    "average_order_value": "51.32"
  }
}

Complete Information: This endpoint provides the most comprehensive view of a campaign, including all related data needed for campaign management and analysis.

Performance Monitoring: Use the performance_metrics data to assess campaign effectiveness and make data-driven decisions about campaign optimization.

Use Cases

Campaign Detail Use Cases

Campaign Editing

Retrieve current campaign configuration for editing
View all campaign settings before making changes
Understand campaign scope and associations

Performance Analysis

Analyze campaign effectiveness and ROI
Compare performance across different campaigns
Identify successful campaign elements

Administrative Oversight

Review campaign compliance and settings
Audit campaign changes and history
Monitor campaign associations and relationships

Customer Service

Answer customer questions about active campaigns
Understand promotion details for support inquiries
Verify campaign eligibility and requirements

Error Responses

Common Error Scenarios

Campaign Not Found

{
  "error": "Campaign not found",
  "message": "The specified campaign does not exist",
  "code": "CAMPAIGN_NOT_FOUND"
}

Company Mismatch

{
  "error": "Campaign not found",
  "message": "Campaign does not belong to the specified company",
  "code": "CAMPAIGN_COMPANY_MISMATCH"
}

Access Denied

{
  "error": "Access denied",
  "message": "You do not have permission to view this campaign",
  "code": "ACCESS_DENIED"
}

Sensitive Information: Campaign details may include sensitive business information. Ensure proper access controls are in place when displaying this data.

API Documentation - Legacy

API Documentation - Latest

Get Campaign Details

Path Parameters

Response

Example Response

Use Cases

Error Responses

​Path Parameters

​Response

​Example Response

​Use Cases

​Error Responses

Path Parameters

Response

Example Response

Use Cases

Error Responses