Webmarketer API (1.0.0)

This endpoint allows you to send an event to Webmarketer.

An event represent an user action on your website or application that you want to track with Webmarketer.

Ensure you have properly configured your event types in Webmarketer before sending events and the event data you are sending matches your declared event-type schema.

With this enpoint, event ingestion is asynchronous, so you will receive a 200 response even if the event is not yet processed or invalid. You can consult the trashed events in the Webmarketer interface.

This endpoint allows you to send an event to Webmarketer.

An event represent an user action on your website or application that you want to track with Webmarketer. Ensure you have properly configured your event types in Webmarketer before sending events and the event data you are sending matches your declared event-type schema.

Event ingestion is synchronous on this endpoint, so you will receive a 200 response when the event is fully processed.

This endpoint allows you to retrieve a raw event by its id (Event ids are generated by Webmarketer and are globally unique)

The raw event is the event as it was sent to the Webmarketer API, without any transformation, this endpoint does not allow to get the data computed by Webmarketer. If your want to get the computed data, please use the /projects/{projectId}/users/{id}/events or /projects/{projectId}/events/{id} endpoint.

This endpoint allows you to fetch the trashed events.
When an event cannot be processed by Webmarketer (when a mandatory field is missing, or when some fields values are invalid) the event will be stored in the "trash collection", allowing you to investigate and debug.

⚠️ Note: the field key in the errors array will be removed in a near future, the field will be changed to a string.

This endpoint allows you to generate the insight about event.

⚠️ Note that this endpoint get data from the event without using the attribution, if you want insights about attributed data, please refer to TODO.

This endpoint allows you to retrieve multiple metrics and aggregate them by a date dimension and by event-type if needed.

The metrics can be :

• Your statistics technical keys (ie: turnover if you used the e-commerce project bootstrap)
• Your states technical keys (ie: rdv or converted if you declared theses offline states)
• event-count this one is a built-in metric that count the number of events

The classic date dimension can be :

• day
• week
• month
• quarter
• semester
• year

If needed you can use a non-linear date dimension, allowing you to identify seasonality in your data.

• dayOfWeek
• dayOfMonth
• dayOfYear
• weekOfYear
• monthOfYear
• quarterOfYear
• semesterOfYear

You can also use the event-type breakdown, this option will generate an output entry for each couple date interval/event-type.

This endpoint is designed to generate graphs so it is not paginated.

This endpoint allows you to update a state of an event.
After being generated, an event state can evolve. It is common to see a call-me-back event pass to a qualified state after having been qualified by your sales team, then set the converted state when the user order.

If in this example, the event seems to only have one state at a time, this is not how Webmarketer models your events.

For the example above, Webmarketer will store :

• qualified on 2023-08-10T14:30:00Z
• converted on 2023-08-18T17:30:00Z

Each event state is described with a date.

In the future, this modeling will allow you to analyze the transients between theses states (e.g. how long does it take to get a lead from qualified to converted when it comes from Facebook).

Troubleshooting
If you encounter 404 response telling that "No storageKey matching field in this eventType" :

• You may have a typo in the state name
• The state did not exists at the time the event you trying to update where created

In the second case, if you need to update state of past events for which a state did not exists, our team can manually add them to allow historical updates : please contact us.

Even if we love giving you the autonomy to manage your data, we prefer to be cautious about this kind of update, backdating the states can cause inconsistencies (e.g. when renaming states over time), our experts will ensure that "backdating" will not cause side effects)

This endpoint allows you to update a statistic of an event.
Event statistic allow you to inform Webmarketer about your event metrics (like turnover, or quoted amount).

A classical situation is when an event leads to a sale of 4 000€.

By updating the "turnover" stat, you allow Webmarketer to affect this amount to the campaigns that led to this event (according to your attribution models).

E.g. : with a linear model and two interactions : 50% google (2000€), 50% facebook (2000€)

As for event state, a statistic can also be set to a specific date.

In the future, this modeling will allow you to analyze the transients between theses states (e.g. how long does it take to get a lead from qualified to converted when it comes from Facebook).

Troubleshooting
If you encounter 404 response telling that "No storageKey matching field in this eventType" :

• You may have a typo in the state name
• The state did not exists at the time the event you trying to update where created

In the second case, if you need to update state of past events for which a state did not exists, our team can manually add them to allow historical updates : please contact us.

Even if we love giving you the autonomy to manage your data, we prefer to be cautious about this kind of update, backdating the states can cause inconsistencies (e.g. when renaming states over time), our experts will ensure that "backdating" will not cause side effects)

This endpoint allows you to retrieve an event by its id (Event ids are generated by Webmarketer and are globally unique)

The event is the computed event from the raw event which was sent to the Webmarketer API (linked user, passed data parsed).

This endpoint allows you to retrieve all metric by their user id (Event ids are generated by Webmarketer and are globally unique)

The raw event is the event as it was sent to the Webmarketer API, without any transformation, this endpoint does not allow to get the data computed by Webmarketer. The event is the computed data created from the raw event sent to the Webmarrketer API (linked user, passed data parsed)

This endpoint allows you to retrieve the list of your project event-types.

The result is paginated.

This endpoint allows you to create a new event-type.

This endpoint allows you to retrieve a specific event-type

This endpoint allows you to retrieve a paginated list of custom campaigns for a Custom Ads integration.

You can filter the campaigns by active status, campaign ID, campaign slug, name, and explicit status.

Please note that campaign ID is different from the campaign slug. The campaign ID can be retrieved through the GET campaigns endpoint. The campaign slug is a user-defined identifier for the campaign to be used in the URL.

Explicit campaigns are campaigns that were explicitly created by the user. Implicit campaigns are campaigns that were created by the system when traffic is detected with the integration wmktid but no explicit campaign slug is provided.

This endpoint allows you to create a custom campaign for a Custom Ads integration.

Please note that :

• the campaign slug must be unique within the integration,
• the campaign will be declared as explicit (as it was created by a user).

This endpoint allows you to retrieve a Custom Ads campaign for a given integration.

Note that the campaignId is not the same as the campaign slug, this id is generated by Webmarketer on campaign creation and can be retrieved through the GET campaigns endpoint.

Note that the returned campaign could be an implicit campaign, automatically created by the system when traffic is detected without any associated explicit campaign.

This endpoint allows you to update a custom campaign for a Custom Ads integration.

You can update the campaign name and its active status.

This endpoint allows you to retrieve a paginated list of outlays for a given Custom Ads campaign.

This endpoint allows you to create an outlay for a given Custom Ads campaign.

Region and country are optional fields and can be used to pass additional information about the outlay (for future reports in Webmarketer).

This endpoint allows you to retrieve an outlay for a given Custom Ads campaign.

This endpoint allows you to update an outlay for a given Custom Ads campaign.

Region and country are optional fields and can be used to pass additional information about the outlay (for future reports in Webmarketer).