Evidon Privacy Api - Documentation

Default call used to get all the users domains. We also have the option to pass in a query string with the domain parameter. This will instruct this call to only pull notices for that domain. This is primarily used when modifying a notice to keep us from adding duplicate countries to multiple notices for the same domain since domain/country pair must be unique.

Returns the active scan counts for your company. This allows you to pull the counts to make sure you are still operating within your contract limits.

Deletes the site notice with the specified id value. When a notice is deleted it disables the notice for the specified domain and clears out the settings stored on our CDN. This will disable the notice within a few minutes.

Retrieves the details for the specified site notice.

Saves the given site notice. If the passed in site notice has a non-zero identifier this call will act as an update. A missing or 0 id value will cause a new notice to be inserted. The passed in notice structure will be validated and if there are errors the return status code will be 500 and the return content will be a list of validation issues.

Recreates the settings file for SiteNotice v3 for a specific company and domain.

Pulls the universal script tag for the active company.

Pulls the specified tag for the active company.

Pulls the list of company themes which can be assigned to a site notice. This list contains the theme names and id values. It also contains the domains being used for each theme.

Pulls the details for a site notice theme.

Saves the site notice theme. This action behaves like an upsert. If the id value is missing or 0 the operation will create a new theme record. Otherwise this will try to modify the existing theme.

Deletes the specified theme, based on the passed in identifier. Note the attempt to delete will fail if there are still notices using the theme.

Pulls the list of consent tool themes.

Pulls the details for the specified consent tool theme.

Saves the consent tool theme. This action behaves as an upsert action. If the id value is missing or 0 this will create a new consent tool theme. If the id value is present it will attempt to modify the existing theme.

Deletes the specified consent tool theme, based on the passed in identifier. Note the attempt to delete will fail if there are still notices using the theme.

Pulls the list of regulations.

Pulls the list of Ad Notices for your company. This query returns a simple list of notice information which includes the Id, Name, Country List, Status and Division. The Status is important. If the status is 1 the Ad Notice is active in production. If the status is 0 it is a draft notice.

Pulls the Ad Notice specified by the given identifier. This will include all the information about the ad notice with all settings.

Saves the Ad Notice.

Deactivates the ad notice.

Generates an Ad Notice which is a copy of the notice specified by the passed in notice identifier. The copied notice is returned from this call.

Deprecated. Do not use.

Deprecated. Do not use.

Pulls the ad notice tags for the passed in notice types and ad sizes.

Deprecated. Do not use.

Deprecated. Do not use.

Deprecated. Do not use.

Gets the templates.

Gets the template.

Saves the template.

Gets the notices.

Gets the division templates.

Deletes the templates with the specified id value. A template is only deleted when there is/are not notices attached to it.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Executes a copy operation, creating a new translation group based on the translation group identifier provided. The newly created group is returned to the caller.

Deletes a company translation group. This operation will only succeed if the translation group you are trying to remove is not assigned to an active site notice.

Saves the passed in translation group. This operation is very limited in what it can do. The only thing this actually saves is the name of the group. If you want to change the actual translation values you need to open the specific translation, modify the desired values, and then save that company translation individually.

Pulls the list of vendor categories for the specified company translation. This method allows the vendor categories to be pulled separate from the main company translation.

Pulls the list of in progress category buckets for a company

Pulls one in progress category bucket for a company

Pulls vendor categories and translations from default translation set in english for use in bucketing.

Saves a provided category bucket.

Deletes the category bucket.

Publishes the category buckets.

Gets the last category bucket published date.

Pulls the specified company translation record.

Pulls the list of Company Translation Groups for your company.

Saves the passed in Company Translation object. You are not allowed to create a new company translation record using this mechanism, only update an existing set of translation values.

Given a set of translation ids, a CSV formatted file will be returned.

Given a csv file string containing translations to be inserted.

Pulls the details for the image asset with the passed in identifier.

Pulls the list of company image assets for your company.

Saves the passed in company image. If an array of image data (the Source property) is passed in that will be uploaded into our CDN for distribution. If the new image is being passed into an existing image record that will trigger an overwrite of the old image assigned to this record with the new one. So only do that if you are trying to swap out an image globally.

Deletes the specified image record.

Pulls a list of recent consent reports which have been generated for this company.

Saves a consent report execution record. Keeping a list of these will allow the contents of the reports to be available for retrieval at a future date.

Returns a list of all of your Consent Tests

Returns a list of all Consent Tests that are currently in progress

Gets a specific Consent Test by id

Saves a Consent Test to the database

Reverts the changes that this Consent Test has put into place, restoring the notice to its original state.

Gets the consent rate data associated with this Consent Test's notice

Gets the category sets.

Gets the template category sets.

Gets the countries.

Gets the languages.

Gets the overlay templates.

Gets the advertisers.

Gets the ad sizes.

Gets the tag types.

Gets the opt out translations.

Gets the overlay translations.

Gets the site notice translations.

Gets the domains.

Gets the fonts.

Adds the site notice access request.

Verifies the email.

Updates the request details.

Gets the company requests.

Creates the export request.

Gets the export requests.

Pulls the list of Rights.

Pulls the list of regulations with rights.

Gets the site notices.

Gets the site notice.

Saves the site notice.

Deletes the site notice, removing it from the list of notices and disabling it from working.

Gets the site notice tag.

This method allows the user to search for a site notice based on either the name or the id. We expect the passed in site notice to hold either a name or an id. We will use the name value first

Gets list of Vendors.

Gets the the company perma link information list.

Saves the VendorList.js.

Gets the list if ad servers.

Gets the list of mobile vendors.

Gets the list of countries.

Gets proxy countries.

Returns a list of states.

Gets all valid Ad Notices.

Gets the specified Ad Notice.

Saves the specified App notice.

This method is called explicitly to pull the information needed for the mobile app developer. Currently that consists of the id's (notice and company) as well as the list of vendors.

Deletes the specified App Notice.

This method should be used to decide whether an AppNotice should display the GDPR Access Request functionality based on if a company has configured it to do so.

This method is used to create a GDPR Access Request

Asynchronously gets the AppNotice Configuration without vendors list attached.