Admedia API (V6) - GET (Read)

Querying Generated Ad Media via the V6 REST-API

To ensure simple and efficient management of generated ad media, the V6 REST-API provides a query function. This feature allows users to retrieve relevant data regarding the ad media and their corresponding tracking links.

Endpoint

• For Admins: https://SUBDOMAIN.de/ws/V6/admin/JSON/Admedia

Required Parameters

• campaign_id: ID of the respective campaign (Mandatory)

• project_id: ID of the respective project (Optional)

Example Request with cURL

curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" https://DOMAIN/ws/V6/admin/JSON/Admedia?campaign_id=1&project_id=50001

Expected Response

Upon a successful request, the API returns the following information about the ad media in JSON format:

• id: ID of the ad media (Integer)

• title: Title of the ad media (String)

• campaign_id: ID of the assigned campaign (Integer)

• project_id: ID of the assigned project (Integer, if provided)

• clicklink: Click link of the ad media (String)

• viewlink: View link of the ad media (String)

• adcode: JavaScript code / HTML code of the tracking link (String)

📘 Error Handling

• If the campaign_id is missing or invalid, an appropriate error message will be returned.

• If no data exists for the specified parameters, an empty dataset (array) will be returned.