Get action by action key

Returns a single conversion action identified by its unique action key string.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/action/{actionKey}.do

Returns a single conversion action identified by its unique action key string. If the optional 'campaignId' query parameter is provided, the response will include the computed pixel key for that campaign context (derived from advertiser ID + campaign ID + action ID). Without campaignId, 'pixelKey' is omitted from the response. Returns 404 if no action matches the given key. Requires authentication.

Path Params

actionKey string required

The unique action key string that identifies the action.

a1b2c3d4e5

Query Params

campaignId integer

Optional campaign ID. When provided, the response includes the computed pixelKey for this campaign context (advertiserID + campaignID + actionID).

2001

Responses

200

Action object with id, key, name, conversion time frames, and optionally a campaign-specific pixelKey

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not enough permissions

404

No action found with the given action key

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5.do?campaignId=2001")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body