List New Strategy Plans
Get a list of new strategy plans
Request
- Base URLhttps://api.mediamath.com/api/v3.0
- AuthOAuth 2Authorization codehttps://auth.mediamath.com/authorizeToken URLhttps://auth.mediamath.com/oauth/tokenScopesoffline_access, manage:services
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Numeric ID of the organization to get campaign plans for
Numeric ID of the agency to get campaign plans for
Numeric ID of the advertiser to get campaign plans for
Number of elements in the collection to retrieve
Index of the first element in the collection to retrieve
The field to sort by. You can use any field name in ascending or descending order. For ascending order, use the field name directly, e.g., id. For descending order, prefix the field name with a hyphen (-), e.g., -id.
Query search for filtering. This parameter can be used to filter results based on various fields. Supported operators:
- == - numeric equality or case-sensitive string identity,
- ==(1,2,3) - IN query (only works for integers),
- != - numeric inequality or case-sensitive string non-identity,
- =: - case-insensitive match, allows substring using * wildcards,
- !: - case-insensitive non-match ("does not contain"), allows substring using * wildcards; rows where the field is NULL are excluded,
- < - less than,
- <= - less than or equal to,
- > - greater than,
- >= - greater than or equal to. Examples:
- q=name=:{search}* to find all results with names starting with {search}.
- Numeric q=id=:*123* searches are treated as exact primary-key matches, equivalent to q=id==123; likewise q=id!:*123* is equivalent to q=id!=123.
- q=name!:*promo* to exclude all results whose name contains "promo".
- q=status==true to find all active entities.
- q=id>=1000 to find all entities with id greater than or equal to 1000.
- q=id==(1,2,3) to find specific entities by ID.
- q=created_on>1999-02-02 or q=created_on>1999-02-02T00:00:00Z to find entities created later than date.
- q=id>5&status==true to find all active entities with id greater than 5.
Get extended properties in response
Response
List new strategy plans response
Example response
{
"data": [
{
"zone_name": "America/New_York",
"goals": {
"bid_min_devices": 1
},
"frequency": {
"frequency_amount": 5
},
"inventory": {
"domain_restrictions": {
"include": [
{
"domain": "www.mediamath.com"
}
],
"exclude": [
{
"domain": "www.mediamath.com"
}
]
},
"site_lists": [
{
"site_list_id": 32
}
],
"deals": [
{
"deal_id": 8
}
],
"deal_groups": [
{
"deal_group_id": 9
}
],
"supply_sources": [
{
"supply_source_id": 54
}
]
},
"targeting": {
"audience": {
"include": [
{
"segments": [
{
"audience_segment_id": 24
}
]
}
],
"exclude": {
"segments": [
{
"audience_segment_id": 24
}
]
}
},
"contextual": {
"include": [
{
"segments": [
{
"targeting_segment_id": 33
}
]
}
],
"exclude": {
"segments": [
{
"targeting_segment_id": 33
}
]
}
},
"postal_codes": {
"restriction": "INCLUDE",
"codes": [
"us-14392",
"us-24981",
"us-25632",
"us-16191",
"us-48574",
"us14392",
"us24981",
"us25632",
"us16191",
"us48574",
"14392",
"24981",
"25632",
"16191",
"48574"
]
},
"geofence": {
"include": {
"segments": [
{
"geofence_segment_id": 45
}
]
},
"exclude": {
"segments": [
{
"geofence_segment_id": 45
}
]
}
},
"my_data": {
"include": {
"pixels": [
{
"pixel_id": 65
}
]
},
"exclude": {
"pixels": [
{
"pixel_id": 65
}
]
}
},
"location": {
"include": [
{
"target_value_id": 87
}
],
"exclude": [
{
"target_value_id": 87
}
]
},
"technology": {
"include": [
{
"target_value_id": 77
}
],
"exclude": [
{
"target_value_id": 77
}
]
},
"ip_addresses": {
"restriction": "INCLUDE"
},
"day_parts": [
{
"start_hour": 1,
"end_hour": 5,
"days": [
"M",
"T",
"W",
"S",
"U"
]
}
],
"recency": [
{
"pixel_id": 67,
"from_hour": 5,
"to_hour": 7
}
]
},
"id": 33,
"version": 3,
"campaign_id": 8
}
],
"meta": {
"status": "success",
"count": 10,
"total_count": 100
}
}Changes
No recorded changes to this operation across all 1 revision of this API.