Az OptiMonk Public API lehetővé teszi az OptiMonk fiókja különböző aspektusainak elérését, beleértve a kampány részleteit, leadeket, fiókinformációkat és jelentéseket. Segít kedvenc jelentéskészítő eszközének csatlakoztatásában és egy egyéni irányítópult létrehozásában, amely könnyen érthető módon mutatja be OptiMonk kampányainak eredményeit.

Íme a főbb mérőszámok, amelyeket könnyedén lekérhet és megjeleníthet egyéni irányítópultján a Reporting API segítségével:

Konverziók: Kövesse nyomon az OptiMonk kampányai által generált sikeres konverziók számát.
Megjelenítések: Mérje a kampányai látogatóknak való megjelenítésének teljes számát.
Konverziós Ráta: Értse meg kampányai hatékonyságát a konverziós ráta kiszámításával, amely a konverziós eseményt elérő látogatók százalékos aránya.
Feliratkozók: Kövesse feliratkozói listájának növekedését közvetlenül az egyéni irányítópultról.
Látogatói Limit: Tartsa szemmel weboldala látogatóinak számát, segítve a kampánystratégiával kapcsolatos megalapozott döntések meghozatalát.

1. Hogyan generáljon API kulcsot az OptiMonkban

A kampányadatok zökkenőmentes integrálásához és eléréséhez a Reporting API-n keresztül kövesse ezeket az egyszerű lépéseket:

1. Jelentkezzen be OptiMonk fiókjába a következő címen: https://app.optimonk.com/login/en

2. Kattintson a fiók menüre a bal oldali navigációs sáv alján és válassza a Beállítások.

3. Itt, a Fiókalatt találja az API kulcsokat.

4. Kattintson az API kulcs generálása gombra ezen az oldalon. Az API kulcsa azonnal megjelenik, és másolásra kész lesz.

2. OptiMonk Public API Dokumentáció

Ezen a ponton szüksége lehet egy fejlesztő segítségére az egyéni integráció létrehozásához. Kérjük, ossza meg velük az OptiMonk Public API dokumentációnkat.

2.1 Áttekintés

Ez a dokumentáció információkat nyújt az elérhető végpontokról, paraméterekről, válaszokról és hitelesítésről.

Alap URL: https://api.optimonk.com/v1

2.2 Hitelesítés

Az Optimonk Public API-hoz intézett minden kérésnek tartalmaznia kell egy API kulcsot az x-api-key fejlécben.

2.3 Végpontok

2.3.1 Általános Kampány Részletek

GET /v1/campaigns/

Leírás: Általános kampány részletek lekérése.
Paraméterek:
- page (opcionális): Lapozási index (alapértelmezett: 1).
Fejlécek:
- x-api-key: A fiókjához generált API kulcs.
Válaszok:
- 200 OK: Általános kampánystatisztikák.
- 400 Hibás Kérés: A kérés nem érvényes.
- 401 Jogosulatlan: A megadott API kulcs nem érvényes.
- 406 Nem Elfogadható: Az API kulcs nincs megadva.
- 429 Túl Sok Kérés: Az API kulcs rátakorlátja elérve.

GET /v1/campaigns/{id}

Leírás: Konkrét kampány részleteinek lekérése.
Paraméterek:
- id (kötelező): A kampány egyedi azonosítója.
Fejlécek:
- x-api-key: A fiókjához generált API kulcs.
Válaszok:
- 200 OK: Kampány részletek.
- 401 Unauthorized: A megadott API kulcs érvénytelen.
- 404 Not Found: A megadott azonosítójú kampány nem található.
- 406 Not Acceptable: Az API kulcs nincs megadva.
- 429 Too Many Requests: Az API kulcs elérte a korlátot.

2.3.2 Leadek Exportálása

GET /v1/leads/

Leírás: Minden kampány leadjeinek exportálása.
Paraméterek:
- interval (opcionális): Előre meghatározott időkeretek (napi, heti, havi, éves, egyéni).
- from (opcionális): Meghatározott időkeret kezdő dátuma.
- to (opcionális): Meghatározott időkeret záró dátuma.
- page (opcionális): Lapozási index (alapértelmezett: 1).
Fejlécek:
- x-api-key: A fiókjához generált API kulcs.
Válaszok:
- 200 OK: Exportált leadek.
- 400 Bad Request: A kérés érvénytelen.
- 401 Unauthorized: A megadott API kulcs érvénytelen.
- 406 Not Acceptable: Az API kulcs nincs megadva.
- 429 Too Many Requests: Az API kulcs elérte a korlátot.

2.3.3 Általános Fiókadatok

GET /v1/account/

Leírás: Általános fiókadatok lekérése.
Fejlécek:
- x-api-key: A fiókjához generált API kulcs.
Válaszok:
- 200 OK: Általános fiókadatok.
- 401 Unauthorized: A megadott API kulcs érvénytelen.
- 406 Not Acceptable: Az API kulcs nincs megadva.
- 429 Too Many Requests: Az API kulcs elérte a korlátot.

2.3.4 Általános Jelentés

GET /v1/report/

Leírás: Az általános kampányjelentés lekérése.
Paraméterek:
- groupBy (opcionális): Dátum csoportosítási paraméter (napi, heti, havi, éves).
- from (opcionális): Meghatározott időkeret kezdő dátuma.
- to (opcionális): Meghatározott időkeret záró dátuma.
Fejlécek:
- x-api-key: A fiókjához generált API kulcs.
Válaszok:
- 200 OK: Általános kampányjelentés.
- 400 Bad Request: A kérés érvénytelen.
- 401 Unauthorized: A megadott API kulcs érvénytelen.
- 406 Nem elfogadható: Az API kulcs nincs megadva.
- 429 Túl sok kérés: Az API kulcs elérte a korlátot.

GET /v1/report/{campaignId}

Leírás: Adott kampányjelentés lekérése.
Paraméterek:
- groupBy (opcionális): Dátum csoportosítási paraméter (napi, heti, havi, éves).
- from (opcionális): Időkeret kezdő dátuma.
- to (opcionális): Időkeret záró dátuma.
- campaignId (kötelező): A kampány egyedi azonosítója.
Fejlécek:
- x-api-key: A fiókjához generált API kulcs.
Válaszok:
- 200 OK: Adott kampányjelentés.
- 400 Hibás kérés: A kérés nem érvényes.
- 401 Jogosulatlan: A megadott API kulcs nem érvényes.
- 404 Nem található: A megadott azonosítójú kampány nem található.
- 406 Nem elfogadható: Az API kulcs nincs megadva.
- 429 Túl sok kérés: Az API kulcs elérte a korlátot.

2.4 Példa API hívások

PHP Curl

<?php

// Optimonk API endpoint
$api_url = 'https://api.optimonk.com/v1/campaigns/';

// API key
$api_key = 'YOUR_API_KEY';

// Pagination index (optional)
$page = 1;

// Set up cURL
$ch = curl_init($api_url . '?page=' . $page);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, &#91;'x-api-key: ' . $api_key&#93;);

// Execute cURL session and get the response
$response = curl_exec($ch);

// Check for errors
if (curl_errno($ch)) {
echo 'Curl error: ' . curl_error($ch);
} else {
// Decode the JSON response
$decoded_response = json_decode($response, true);

// Handle the response as needed
print_r($decoded_response);
}

// Close cURL session
curl_close($ch);

?>

JavaScript

// Optimonk API endpoint
const apiURL = 'https://api.optimonk.com/v1/campaigns/';

// API key
const apiKey = 'YOUR_API_KEY';

// Pagination index (optional)
const page = 1;

// Set up Fetch API request
fetch(`${apiURL}?page=${page}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'x-api-key': apiKey,
},
})
.then(response => {
// Check if the request was successful (status code 200)
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
return response.json(); // Parse the JSON response
})
.then(data => {
// Handle the response data as needed
console.log(data);
})
.catch(error => {
// Handle errors
console.error('Fetch error:', error.message);
});