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

Uplifts

Operations related to Uplifts for creating mutually exclusive test and control segments to measure incremental campaign impact through A/B testing. Enable measurement of true campaign effectiveness by comparing exposed groups against unexposed control groups to determine uplift in conversions and other KPIs.

Find an uplift

get
/datamarts/{datamart_id}/uplifts
Path parameters
datamart_idinteger · int64Required
Query parameters
idstringOptional

The id of the uplift

namestringOptional

The name of the uplift

descriptionstringOptional

The description of the uplift

initialSourceTypestring · enumOptional

The initial source type of the uplift

Possible values:
initialQueryTextstringOptional

The initial initial query text of the uplift

controlGroupIdstringOptional

The control group of the uplift

experimentIdsstring[]Optional

Experiments of the uplift

first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that may be returned by this search

order_bystring[]Optional

Fields used to order the result

keywordsstringOptional

Word contained in the audience feature name or description

Responses
200

Success !

application/json
first_resultintegerRequired
countintegerRequired
totalintegerRequired
statusstring · enumRequiredPossible values:
max_resultsintegerRequired
get/datamarts/{datamart_id}/uplifts
GET /v1/datamarts/{datamart_id}/uplifts HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "first_result": 1,
  "data": [
    {
      "description": "text",
      "control_group_id": "text",
      "name": "text",
      "last_modified_by": "text",
      "datamart_id": "text",
      "archived": false,
      "last_modified_ts": 0,
      "created_by": "text",
      "initial_query_text": "text",
      "experiment_ids": [
        "text"
      ],
      "id": "text",
      "initial_source_type": "QUERY",
      "creation_ts": 0
    }
  ],
  "count": 1,
  "total": 1,
  "status": "ok",
  "max_results": 1
}

Create an uplift

post
/datamarts/{datamart_id}/uplifts
Path parameters
datamart_idinteger · int64Required
Body
descriptionstringOptional
control_group_idstringRequired
namestringRequired
last_modified_bystringRead-onlyRequired
datamart_idstringRequired
archivedbooleanRequiredDefault: false
last_modified_tsinteger · int64Read-onlyRequiredDefault: 0
created_bystringRead-onlyRequired
initial_query_textstringRequired
experiment_idsstring[]Required
idstringRead-onlyRequired
initial_source_typestring · enumRequiredPossible values:
creation_tsinteger · int64Read-onlyRequiredDefault: 0
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/uplifts
POST /v1/datamarts/{datamart_id}/uplifts HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "description": "text",
  "control_group_id": "text",
  "name": "text",
  "datamart_id": "text",
  "archived": false,
  "initial_query_text": "text",
  "experiment_ids": [
    "text"
  ],
  "initial_source_type": "QUERY"
}
{
  "status": "ok",
  "data": {
    "description": "text",
    "control_group_id": "text",
    "name": "text",
    "last_modified_by": "text",
    "datamart_id": "text",
    "archived": false,
    "last_modified_ts": 0,
    "created_by": "text",
    "initial_query_text": "text",
    "experiment_ids": [
      "text"
    ],
    "id": "text",
    "initial_source_type": "QUERY",
    "creation_ts": 0
  }
}

Get an uplift

get
/datamarts/{datamart_id}/uplifts/{uplift_id}
Path parameters
datamart_idinteger · int64Required
uplift_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/datamarts/{datamart_id}/uplifts/{uplift_id}
GET /v1/datamarts/{datamart_id}/uplifts/{uplift_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "description": "text",
    "control_group_id": "text",
    "name": "text",
    "last_modified_by": "text",
    "datamart_id": "text",
    "archived": false,
    "last_modified_ts": 0,
    "created_by": "text",
    "initial_query_text": "text",
    "experiment_ids": [
      "text"
    ],
    "id": "text",
    "initial_source_type": "QUERY",
    "creation_ts": 0
  }
}

Update an uplift

put
/datamarts/{datamart_id}/uplifts/{uplift_id}
Path parameters
datamart_idinteger · int64Required
uplift_idstringRequired
Body
descriptionstringOptional
control_group_idstringRequired
namestringRequired
last_modified_bystringRead-onlyRequired
datamart_idstringRequired
archivedbooleanRequiredDefault: false
last_modified_tsinteger · int64Read-onlyRequiredDefault: 0
created_bystringRead-onlyRequired
initial_query_textstringRequired
experiment_idsstring[]Required
idstringRead-onlyRequired
initial_source_typestring · enumRequiredPossible values:
creation_tsinteger · int64Read-onlyRequiredDefault: 0
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/datamarts/{datamart_id}/uplifts/{uplift_id}
PUT /v1/datamarts/{datamart_id}/uplifts/{uplift_id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "description": "text",
  "control_group_id": "text",
  "name": "text",
  "datamart_id": "text",
  "archived": false,
  "initial_query_text": "text",
  "experiment_ids": [
    "text"
  ],
  "initial_source_type": "QUERY"
}
{
  "status": "ok",
  "data": {
    "description": "text",
    "control_group_id": "text",
    "name": "text",
    "last_modified_by": "text",
    "datamart_id": "text",
    "archived": false,
    "last_modified_ts": 0,
    "created_by": "text",
    "initial_query_text": "text",
    "experiment_ids": [
      "text"
    ],
    "id": "text",
    "initial_source_type": "QUERY",
    "creation_ts": 0
  }
}

Delete an uplift

delete
/datamarts/{datamart_id}/uplifts/{uplift_id}
Path parameters
datamart_idinteger · int64Required
uplift_idstringRequired
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/datamarts/{datamart_id}/uplifts/{uplift_id}
DELETE /v1/datamarts/{datamart_id}/uplifts/{uplift_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Last updated

Was this helpful?