For the complete documentation index, see llms.txt. This page is also available as Markdown.

Plugins

Operations related to Plugins, the extensible web service components hosted by the platform that add custom functionality. Plugin types include:

  • Activity Analyzers (enrich tracking data)

  • Audience Segment External Feeds (sync segments to partners)

  • Display Ad Renderers (customize ad rendering)

  • Email Renderers (customize email rendering)

  • Email Routers (manage email sending)

  • Attribution Engines (custom attribution)

  • Custom Actions (automation actions)

  • ML Algorithms (predictions)

  • Computed Fields (calculated schema fields)

Relevant documentation:

Get a Plugin Version Configuration file

get
/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name}
Path parameters
plugin_idstringRequired

ID of the plugin

plugin_version_idstringRequired

ID of the plugin version

technical_namestringRequired

technical name of the Plugin Version Configuration

Responses
200

Success !

application/octet-stream
string · binaryOptional
get/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name}
GET /v1/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
binary

Put a Plugin Version Configuration file

put
/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name}
Path parameters
plugin_idstringRequired

ID of the plugin

plugin_version_idstringRequired

ID of the plugin version

technical_namestringRequired

technical name of the Plugin Version Configuration

Body
string · binaryOptional
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
put/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name}
PUT /v1/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "status": "ok"
}

Delete a Plugin Version Configuration file

delete
/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name}
Path parameters
plugin_idstringRequired

ID of the plugin

plugin_version_idstringRequired

ID of the plugin version

technical_namestringRequired

technical name of the Plugin Version Configuration

Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name}
DELETE /v1/plugins/{plugin_id}/versions/{plugin_version_id}/configuration_file/technical_name={technical_name} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

make an action on a plugin

put
/plugins/{plugin_id}/actions
Path parameters
plugin_idstringRequired

ID of the plugin

Body
or
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/plugins/{plugin_id}/actions
PUT /v1/plugins/{plugin_id}/actions HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "type": "ARCHIVE_PLUGIN",
  "plugin_id": "text"
}
{
  "status": "ok",
  "data": {
    "plugin_type": "DISPLAY_CAMPAIGN_EDITOR",
    "group_id": "text",
    "organisation_id": "text",
    "artifact_id": "text",
    "archived": false,
    "current_version_id": "text",
    "id": "text"
  }
}

make an action on a plugin version

post
/plugins/{plugin_id}/versions/{plugin_version_id}/actions
Path parameters
plugin_idstringRequired

ID of the plugin

plugin_version_idstringRequired

ID of the plugin version

Body
or
or
or
or
or
or
or
or
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/plugins/{plugin_id}/versions/{plugin_version_id}/actions
POST /v1/plugins/{plugin_id}/versions/{plugin_version_id}/actions HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "type": "PUBLISH_LIVE_VERSION",
  "plugin_version_id": "text",
  "plugin_id": "text"
}
{
  "status": "ok",
  "data": {
    "version_id": "text",
    "features": [
      "CLEANING_AND_DELETION"
    ],
    "id": "text",
    "organisation_id": "text",
    "artifact_id": "text",
    "archived": false,
    "image_name": "text",
    "tenant_credentials_scheme": "GOOGLE_SERVICE_ACCOUNT",
    "script_path": "text",
    "build_tag": "text",
    "group_id": "text",
    "file_delivery_activated": false,
    "identifying_resources_locked": false,
    "maintainer_id": "text",
    "authenticate_at_instantiation": false,
    "status": "DRAFT",
    "engine_type": "NATIVE",
    "plugin_type": "DISPLAY_CAMPAIGN_EDITOR",
    "plugin_id": "text"
  }
}

Fetch available dynamic property values from the plugin connector

post
/plugins/{plugin_id}/versions/{plugin_version_id}/dynamic_property_values_queries
Path parameters
plugin_idstringRequired

ID of the plugin

plugin_version_idstringRequired

ID of the plugin version

Body
datamart_idstringRequired
feed_destination_idstringOptional
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/plugins/{plugin_id}/versions/{plugin_version_id}/dynamic_property_values_queries
POST /v1/plugins/{plugin_id}/versions/{plugin_version_id}/dynamic_property_values_queries HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "properties": [
    {
      "writable": false,
      "value": {},
      "origin": "PLUGIN_STATIC",
      "technical_name": "text",
      "deletable": false
    }
  ],
  "datamart_id": "text",
  "feed_destination_id": "text"
}
{
  "status": "ok",
  "data": {
    "status": "ok",
    "message": "text",
    "data": [
      {
        "property_technical_name": "text",
        "enum": [
          {
            "value": "text",
            "label": "text"
          }
        ]
      }
    ],
    "count": 0
  }
}

Find all running plugin containers grouped by plugin-manager based on a plugin version

get
/plugins/{plugin_id}/versions/{version_id}/containers
Path parameters
plugin_idinteger · int64Required

The plugin id

version_idinteger · int64Required

The plugin version id

Query parameters
organisation_idinteger · int64Required

The organisation in which the search is performed

first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that shall be return by this search

Responses
200

Success !

application/json
max_resultsintegerRequired
first_resultintegerRequired
statusstring · enumRequiredPossible values:
countintegerRequired
totalintegerRequired
get/plugins/{plugin_id}/versions/{version_id}/containers
GET /v1/plugins/{plugin_id}/versions/{version_id}/containers?organisation_id=1 HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "data": [
    {
      "name": "text",
      "running_containers": [
        {
          "container": "text"
        }
      ]
    }
  ],
  "max_results": 1,
  "first_result": 1,
  "status": "ok",
  "count": 1,
  "total": 1
}

Search accessible plugins for the segment

get
/audience_segments/{segment_id}/available_plugins
Path parameters
segment_idinteger · int64Required

The segment id

Query parameters
plugin_typestring · enumOptional

The type of plugins

Possible values:
artifact_idinteger · int64Optional

Artifact id

group_idinteger · int64Optional

Group id

organisation_idinteger · int64Optional

Organisation id

organisation_idsinteger · int64[]Optional

List of organisation Ids we want to query

order_bystring[]Optional

Fields used to order the result

keywordsstringOptional

Can be used to search elements

current_version_statusesstring[]Optional

Current version statuses

archivedbooleanOptional

If true the result will contain only archived dashboards

first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that shall be return by this search

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
first_resultintegerRequired
countintegerRequired
max_resultsintegerRequired
totalintegerRequired
get/audience_segments/{segment_id}/available_plugins
GET /v1/audience_segments/{segment_id}/available_plugins HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "first_result": 1,
  "data": [
    {
      "plugin_type": "DISPLAY_CAMPAIGN_EDITOR",
      "group_id": "text",
      "organisation_id": "text",
      "artifact_id": "text",
      "archived": false,
      "current_version_id": "text",
      "id": "text"
    }
  ],
  "count": 1,
  "max_results": 1,
  "total": 1
}

Last updated

Was this helpful?