MGID

MGID is a traffic source (native). Its own documentation: https://help.mgid.com/api-advertisers.

What it connects

Sends your conversions back to MGID.
Pulls your spend from its API.
Blocks placements in a source campaign.
Pauses and resumes its campaigns and ads.
Sets bids on its placements.
Sets daily budgets on its campaigns.
Checks the connection with a harmless request when you test it.

How to connect it

API token. Sent as Authorization: Bearer …, never in a URL.

Conversions go without it: the postback carries no credentials, so a connection that lacks the API’s goes on sending conversions.

Set these on the connection:

Field	Name	Kind	What to enter
Client id	`client_id`	string, required	The id after /postback/ in the postback URL MGID shows under your campaign’s conversion tracking
Account currency	`currency`	string	Your MGID account’s currency, such as USD. Revenue in it is sent with each conversion. Costs read as USD unless the connection overrides /cost
Account time zone	`time_zone`	string	For spend, your MGID account’s time zone, such as Europe/Kyiv, as its settings show it; MGID reports by its days, and it can’t change once spend is reported
API token	`api_token`	string, secret	The API token from your MGID dashboard, for spend and widget blocking; postbacks go without it

A secret is set by the workspace’s owner alone and never shown again. A required secret that is missing holds the connection’s deliveries until it is set; one that is optional holds only what reads it.

Tracking macros

Each token is a query parameter on the campaign URL; the source replaces its macro with the value when it sends the visitor. The columns say which part of the visit it fills and which report column (v1 to v20) it lands in.

Parameter	Macro	Fills	Report column
`click`	`${CLICK_ID}`	The source’s click id
`widget`	`${WIDGET_ID}`	Placement	v1 (Widget)
`teaser`	`${TEASER_ID}`	Creative	v2 (Teaser)
`campaign`	`${CAMPAIGN_ID}`	Source campaign	v3 (Campaign)
`site`	`${SITE_ID}`	Site	v4 (Site)
`category`	`${CATEGORY_ID}`	Custom value	v5 (Category)
`cost`	`${CLICK_PRICE}`	Cost

The campaign URL you paste into the source is the tracking domain, the campaign’s key and the tokens the source fills, in this order (the domain below is an example, and {url_key} stands for the campaign’s own key):

https://trk.example.com/{url_key}?click=${CLICK_ID}&widget=${WIDGET_ID}&teaser=${TEASER_ID}&campaign=${CAMPAIGN_ID}&site=${SITE_ID}&category=${CATEGORY_ID}&cost=${CLICK_PRICE}

Cost models, the first the default: from_token (the source’s own cost, passed in a token), cpc (cost per click), api (the spend pulled from the source’s API).

With from_token, the cost is the value of cost, per visit in USD.

Preview the campaign URL

Your tracking domain

Campaign URL

https://trk.example.com/{url_key}?click=${CLICK_ID}&widget=${WIDGET_ID}&teaser=${TEASER_ID}&campaign=${CAMPAIGN_ID}&site=${SITE_ID}&category=${CATEGORY_ID}&cost=${CLICK_PRICE}

Paste the campaign URL into the source's ad. {url_key} stands for the campaign's own key, which the portal fills in; the macros are the source's, which it replaces with each visit's values.

How conversions get back to it

Tallyray sends a conversion to MGID when it enters one of these statuses: approved. A conversion is sent once per status it enters; an adjustment, with revenue moving and its status not, isn’t sent. A conversion older than 30d isn’t sent.

Tallyray’s event kinds, and the name each is sent as. A conversion of a kind not listed isn’t sent:

Tallyray event	Sent to MGID as
`lead`	`lead`
`registration`	`registration`
`sale`	`sale`
`subscription`	`subscription`
`deposit`	`deposit`

The request: GET https://a.mgid.com/postback/{…}.

A conversion is sent only when this holds:

=visit.external_click_id != ''

Conversions are retried when the source can’t be reached or answers with an error that can pass; see the limits below.

Spend

Tallyray pulls spend from the source’s API every 1h, covering the last 2d again, as sources restate spend, 1d at most per request, by day, in the zone =conn.time_zone != '' ? conn.time_zone : 'set the account time zone'. With api among the cost models, a campaign is priced by it.

The request: GET https://api.mgid.com/v1/goodhits/clients/{…}/statistics-reports.

Pulling spend needs the API’s credential. A connection without it goes on sending conversions and pulls no spend.

Placements

Placements are the visit’s placement value, as the tokens above fill it.

Blocking: PATCH https://api.mgid.com/v1/goodhits/clients/{…}/campaigns/{…}. Mode append: Tallyray sends the placements to add. Lifting a block is sent too.

Pausing and resuming

Rules and reports can pause and resume the source’s own objects at these levels. Tallyray reads an object before it writes, and writes only what isn’t so already, so a repeated pause never toggles anything.

Level	Named by
campaigns	`campaign`
ads	`teaser`

Bids

Rules and reports can set the source’s bids at these levels. Each value is read before it’s written, in the account’s currency, never converted; a value the source sets itself isn’t written.

Level	Named by	Prices	Bounds	Notes
placements	`campaign` + `widget`	`factor`	min 0.1, max 10, step 0.01

Daily budgets

Rules and reports can set the source’s daily budgets at these levels, read before they’re written, in the account’s currency.

Level	Named by	Prices	Bounds	Notes
campaigns	`campaign`	daily	step 0.01

Limits

Rate: at most 10/s per connection, 4 at once.
Retries: up to 15 attempts, waiting from 30s and doubling up to 6h, longer when the source’s Retry-After asks, and never past the conversion’s age limit.
Hosts it reaches: a.mgid.com, api.mgid.com. No other.
What a connection may override: /tokens, /conversions/events, /conversions/send_on, /cost. Hosts, authentication and requests never are, and an override may only lower the limits.

This page describes version 4 of the MGID template, the latest published. The version your connection runs is the one your administrators approved, and the portal shows it.