Get Valid Objectives Configurations

This endpoint retrieves a list of valid objective configurations with valid Industry and Use Case segmentations. You can use this endpoint to check if an objective combination is available on the Neurons API.

Valid objectives are a prerequisite for running our Get Medium Benchmarks, Get Neurons Impact Score and Get Recommendations endpoints.

For more context on how Benchmarks are calculated please refer to our knowledge base.

A valid asset UUID is required to be passed in the request's query parameters. Depending on the type of medium (image or video) the valid objective configurations will be served.

Explaining the fields

The purpose field refers to the primary objective of your content: Brand Building (BB) or Conversion. Read more about it here.

To provide the necessary industry sector context the fields industry_category and industry_subcategory can be used. Read more about it here.

To provide the necessary use case context the fields usecase_category,usecase_subcategory and platform can be used. Read more about it here.

Filtering valid objective configurations

The search can be narrowed down by using query parameters to filter by field.

For example, to filter down all valid objective configurations within the purpose of brand_building:

GET request to /predict/v2/objectives?medium_id=<<YOUR_MEDIUM_UUID>>&purpose=brand_building

To further narrow down for objective configurations with the purpose of brand_building and usecase_category of digital_advertising:

GET request to /predict/v2/objectives?medium_id=\<<YOUR_MEDIUM_UUID>>&purpose=brand_building&usecase_category=digital_advertising

And if we would like to find objective configurations with the purpose of brand_building, usecase_category of digital_advertising and with the industry_subcategory of consumer_electronics or pharma just pass the two values for the same query parameter separated by a comma (,).

GET request to /predict/v2/objectives?medium_id=\<<YOUR_MEDIUM_UUID>>&purpose=brand_building&usecase_category=digital_advertising &industry_subcategory=consumer_electronics,pharma

Example of a successful response

For images:

{
    "valid_objectives_configs": [
        {
            "purpose": "brand_building",
            "industry_category": "durable_goods",
            "industry_subcategory": "consumer_electronics",
            "usecase_category": "digital_advertising",
            "usecase_subcategory": "some_ads",
            "platform": "facebook_feed"
        },
        {
            "purpose": "brand_building",
            "industry_category": "durable_goods",
            "industry_subcategory": "consumer_electronics",
            "usecase_category": "digital_advertising",
            "usecase_subcategory": "some_ads",
            "platform": "instagram_feed"
        },
        ...
    ]
}

For videos:

{
    "valid_objectives_configs": [
        {
            "purpose": "brand_building",
            "industry_category": "durable_goods",
            "industry_subcategory": "consumer_electronics",
            "usecase_category": "digital_advertising",
            "usecase_subcategory": "display_ads",
            "platform": "all"
        },
        {
            "purpose": "brand_building",
            "industry_category": "durable_goods",
            "industry_subcategory": "consumer_electronics",
            "usecase_category": "digital_advertising",
            "usecase_subcategory": "some_ads",
            "platform": "facebook_feed"
        },
        ...
    ]
}