Campaign

API v1

List campaign

View created campaigns for your organization.

POST /management/v1/campaigns

Request

{
    "page": {
        "offset": integer,
        "limit": integer
    },
    "filter": {
        "partnerId": string,
        "campaignId": string
    }
}

Name	Type	Description
offset	uint	Skips the offset rows before beginning to return the response. The default is 0
limit	uint	Determines the number of campaigns returned in the response. The default is 100
partnerId	uint	(Optional) justtrack's identifier for the advertising partner
campaignId	string	(Optional) The identifier for the campaign that originated with the partner

Responses

200

{
    "results": [
        {
            "type": string,
            "countryCodes": []string,
            "createdAt": timestamp,
            "id": string,
            "goalName": string,
            "name": string,
            "partnerId": string,
            "optimizationType": string,
            "platform": string,
            "promoCode": string,
            "updatedAt": timestamp,
            "appId": integer
        }
    ]
}

Name	Type	Description
type	string	The type of campaign. Possible values are acquisition and retargeting.
countryCodes	[]string	A list of country codes. (The two-character ISO country code derived from the IP)
createdAt	timestamp	The date and time in UTC at which the campaign was created.
id	string	(Optional) The identifier for the campaign that originated with the partner
goalName	string	(Optional) justtrack's name for the goal tied to the ad campaign
name	string	The name for the campaign that originated with the partner
partnerId	uint	justtrack's identifier for the advertising partner
optimizationType	string	(Optional) Available options are cpa or cpi.
platform	string	The platform to which the app belongs
promoCode	string	(Optional) The promo code retrievable by the SDK for this campaign.
updatedAt	timestamp	The date and time in UTC at which the campaign was last updated.
appId	timestamp	justtrack's identifier for the app

Create campaign

Create a campaign.

POST /management/v1/campaign

Request

{
    "type": string,
    "appId": integer,
    "countryCodes": []string,
    "id": string,
    "goalName": string,
    "name": string,
    "partnerId": integer,
    "optimizationType": string,
    "promoCode": string
}

Name	Type	Description
type	string	The type of campaign. Possible values are acquisition and retargeting.
appId	timestamp	justtrack's identifier for the app
countryCodes	[]string	A list of country codes. (The two-character ISO country code derived from the IP)
id	string	The identifier for the campaign that originated with the partner
goalName	string	justtrack's name for the goal tied to the ad campaign
name	string	The name for the campaign that originated with the partner
partnerId	uint	justtrack's identifier for the advertising partner
optimizationType	string	Available options are cpa or cpi.
promoCode	string	(Optional) The promo code you want to pass to the SDK for this campaign.

Responses

200

{
    "type": string,
    "countryCodes": []string,
    "createdAt": timestamp,
    "id": string,
    "goalName": string,
    "name": string,
    "partnerId": string,
    "optimizationType": string,
    "platform": string,
    "promoCode": string,
    "updatedAt": timestamp,
    "appId": integer
}

Name	Type	Description
type	string	The type of campaign. Possible values are acquisition and retargeting.
countryCodes	[]string	A list of country codes. (The two-character ISO country code derived from the IP)
createdAt	timestamp	The date and time in UTC at which the campaign was created.
id	string	The identifier for the campaign that originated with the partner
goalName	string	justtrack's name for the goal tied to the ad campaign
name	string	The name for the campaign that originated with the partner
partnerId	uint	justtrack's identifier for the advertising partner
optimizationType	string	Available options are cpa or cpi.
promoCode	string	(Optional) The promo code retrievable by the SDK for this campaign.
platform	string	The platform to which the app belongs
updatedAt	timestamp	The date and time in UTC at which the campaign was last updated.
appId	timestamp	justtrack's identifier for the app

API v0

warning

This is the documentation for API v0, which is no longer maintained.

For up-to-date documentation, see the latest version.

List campaign

This API provides the data of created campaigns for the current user's organization

POST /management/v0/campaigns

Request

{
    "page": {
        "offset": 0,
        "limit": 100
    },
    "filter": {
        "networkVendor": "<networkVendor>",
        "externalCampaignId": "<external campaign id>"
    }
}

Name	Type	Description
offset	int	offset clause skips the offset rows before beginning to return the response. Default 0
limit	int	limit determines the number of campaigns returned in the response. Default 100
networkVendor	string	networkVendor determines the supported partner vendor. Not required
externalCampaignId	string	externalCampaignId determines the partner-specific campaign ID. Not required

Response

{
  "result": [
    {
      "id": int,
      "campaignTypeId": int,
      "goalId": int,
      "name": "string",
      "networkId": int,
      "optimizationType": "string",
      "clientId": int,
      "createdAt": "string",
      "updatedAt": "string",
      "attributes": [
        {
            "name": "fb_adgroup_id",
            "value": "string"
        },
        {
            "name": "fb_adset_id",
            "value": "string"
        },
        {
            "name": "fb_campaign_id",
            "value": "string"
        },
        {
            "name": "act",
            "value": "string"
        }
      ]
    }
  ]
}

Create campaign

This API allows you to create a campaign.

POST /management/v0/campaign

Request

The general request to the Create Campaign API looks like:

{
    "optimizationType": "string",
    "campaignTypeId": int,
    "externalCampaignId": string,
    "clientId": int,
    "networkId": int,
    "countries": ["string", "string"],
    "name": "string",
    "attributes": [
        {
            "name": "string",
            "value": "string"
        },
        ...
    ]
}

Name	Type	Description
optimizationType	string	Available options are cpa or cpi.
campaignTypeId	int	Available options are: 1 for acquisition, 2 for retargeting
externalCampaignId	int	Source Campaign ID. Provided by the partner
clientId	int	The ID of the client. You can obtain it by using the app API.
networkId	int	The ID of the partner. You can obtain it by using the partner API.
countries	[]string	The list of the countries in ISO2 format. For example ["DE", "EN"].
name	string	The name of the new campaign.
attributes	Attributes list	The attributes are partner-specific data to link JustTrack with the Ad Partner.

info

Depending on the partner, externalCampaignId may refer to different fields, e.g. source campaign id, campaign uuid, ...

Attributes

Name	Type	Description
name	string	The attribute name specific for the Ad Partner.
value	string	The attribute value specific for the Ad Partner.

Attributes Facebook example:

"attributes": [
    {
        "name": "fb_adgroup_id",
        "value": "string"
    },
    {
        "name": "fb_adset_id",
        "value": "string"
    },
    {
        "name": "fb_campaign_id",
        "value": "string"
    },
    {
        "name": "act",
        "value": "string"
    }
]

Response

{
  "id": int,
  "active": boolean
}