About this API
Returns delivery status counts and calculated rates for a specific campaign. Queued emails are excluded.
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
Authorization: Bearer <TOKEN>YOUR_ACCESS_TOKENPath Parameters
Substitute these placeholders in the endpoint URL before sending the request.
idstringRequiredID of the campaign to retrieve analytics for.Request Details
Provide identifiers in the path and any supported values in the query string.
Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
curl --request GET 'https://email.1spoc.com/api/user/campaigns/{id}/analytics' \
--header 'Authorization: Bearer <TOKEN>'
const response = await fetch('https://email.1spoc.com/api/user/campaigns/{id}/analytics', {
method: 'GET',
headers: {
"Authorization": "Bearer <TOKEN>"
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
const response = await fetch('https://email.1spoc.com/api/user/campaigns/{id}/analytics', {
method: 'GET',
headers: {
"Authorization": "Bearer <TOKEN>"
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json
import requests
url = 'https://email.1spoc.com/api/user/campaigns/{id}/analytics'
headers = {
"Authorization": "Bearer <TOKEN>"
}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://email.1spoc.com/api/user/campaigns/{id}/analytics"))
.header("Authorization", "Bearer <TOKEN>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://email.1spoc.com/api/user/campaigns/{id}/analytics',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>"],
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var response = await client.GetAsync("https://email.1spoc.com/api/user/campaigns/{id}/analytics");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://email.1spoc.com/api/user/campaigns/{id}/analytics", nil)
if err != nil { panic(err) }
request.Header.Set("Accept", "application/json")
request.Header.Set("Authorization", "Bearer <TOKEN>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}
Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{}
{
"type": "object",
"properties": {
"rates": {
"type": "object",
"properties": {
"openRate": {
"type": "number",
"example": 69.57
},
"clickRate": {
"type": "number",
"example": 47.83
},
"bounceRate": {
"type": "number",
"example": 1.67
},
"failureRate": {
"type": "number",
"example": 2.5
},
"deliveryRate": {
"type": "number",
"example": 95.83
},
"complaintRate": {
"type": "number",
"example": 0.87
}
}
},
"replyTo": {
"type": "string",
"format": "email",
"example": "support@pinnacle.in",
"nullable": true
},
"subject": {
"type": "string",
"example": "Big Spring Savings Inside",
"nullable": true
},
"summary": {
"type": "object",
"properties": {
"totalOpens": {
"type": "integer",
"example": 200
},
"totalClicks": {
"type": "integer",
"example": 140
},
"totalFailed": {
"type": "integer",
"example": 3
},
"uniqueOpens": {
"type": "integer",
"example": 80
},
"totalBounced": {
"type": "integer",
"example": 2
},
"uniqueClicks": {
"type": "integer",
"example": 55
},
"totalDelivered": {
"type": "integer",
"example": 115
},
"totalComplaints": {
"type": "integer",
"example": 1
},
"totalEmailsSent": {
"type": "integer",
"example": 120
}
}
},
"fromName": {
"type": "string",
"example": "Pinnacle Email",
"nullable": true
},
"fromEmail": {
"type": "string",
"format": "email",
"example": "no-reply@pinnacle.in",
"nullable": true
},
"campaignId": {
"type": "string",
"format": "uuid"
},
"completedAt": {
"type": "string",
"format": "date-time",
"example": "2024-06-01T12:30:00.000Z",
"nullable": true
},
"campaignName": {
"type": "string",
"example": "Spring Sale Campaign",
"nullable": true
}
}
}
Status Codes
200Campaign analytics retrieved successfully.400Missing campaign ID.401Unauthorized (missing or invalid user access token)404Campaign not found or deleted.500Internal server error