Mavrck Data Subject Request API
The DataSubjectRequest API from Mavrck — 1 operation(s) for datasubjectrequest.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.0
description: Identify your most influential customers and activate them to drive more conversions on social.
title: MAVRCK.IO Data Subject Request API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: DataSubjectRequest
paths:
/data-subject-request/:
post:
tags:
- DataSubjectRequest
operationId: create
x-handler: data_subject_requests/data_subject_request_controller.js
x-access:
- influencer
- anonymous
summary: Creates or updates a data subject request
parameters:
- name: id
in: query
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
data:
type: object
properties:
contact_info:
type: object
$ref: '#/components/schemas/MembershipContactInfoDeprecated'
activations:
type: array
items:
$ref: '#/components/schemas/ActivationDeprecated'
rewards:
type: array
items:
$ref: '#/components/schemas/IncentiveDeprecated'
'400':
description: Missing or invalid parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Session expired.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Access forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
enum:
- GLOBAL_UNSUBSCRIBE
- GLOBAL_SUBSCRIBE
- DELETE
- EXPORT
- SUBSCRIBE
- UNSUBSCRIBE
description: Type of request
required: true
components:
schemas:
Error:
type: object
properties:
type:
type: string
description: A key representing the type of error that has occurred.
error:
type: string
description: A static description of the type of error.
params:
type: array
description: For errors invovling parameters, this is an array containing the invalid parameters.
items:
type: string
keys:
type: array
items:
type:
- string
- object
artifactLinks:
$ref: '#/components/schemas/LinksDeprecated'
parent:
type: object
properties:
type:
type: string
description: A key representing the type of error generated by a request to an external API.
error:
type: string
description: A static description of the parent error.
BonusTier:
description: 'Swagger 2 representation of a tiered bonus entry.
`upperBound` is required for `BOUNDED` tiers and must be omitted for
`OPEN_ENDED` tiers. The bonus-tier validator enforces that conditional rule.
Validation rules:
- `bonusTiers` may contain at most 5 tiers.
- Tiers must be sorted by `lowerBound`.
- Adjacent tiers must be contiguous.
- The final tier must be `OPEN_ENDED`.
- `bonusTierCurrencyCode` is required when `bonusTiers` is non-empty.'
properties:
type:
type: string
enum:
- BOUNDED
- OPEN_ENDED
lowerBound:
type: number
format: double
description: Inclusive lower conversion/order bound for this payout tier. Must be non-negative.
upperBound:
type: number
format: double
description: Exclusive upper conversion/order bound for a `BOUNDED` tier.
bonusAmount:
type: number
format: double
description: Bonus payout amount in `bonusTierCurrencyCode`. Must be positive.
required:
- type
- lowerBound
- bonusAmount
type: object
additionalProperties: false
WorkflowStatusRequirementDeprecated:
type: object
properties:
satisfied:
type: boolean
incentiveId:
type: number
name:
type: string
QuestionDeprecated:
type: object
properties:
id:
type: integer
description: The question ID
key:
type: string
description: Unique key of the question
type:
type: string
description: Indicates the HTML tag that is used to dynamically render this question.
className:
type: string
description: Additional classes for fields styling and formatting.
questionText:
type: string
description: The text of the question
markUpQuestionText:
type: string
description: The text of the question with HTML markup
questionResponses:
x-access:
- root
- administrator
type: array
items:
type: object
maxResponses:
type: integer
description: Maximum length of responses allowed for this question.
hasResponses:
x-access:
- root
- administrator
type: boolean
templateOptions:
type: object
properties:
type:
type: string
description: Indicates the data type to be submitted for this question in the form response.
label:
type: string
description: Human-readable label for the question.
placeholder:
type: string
description: Placeholder text to be display in the input field.
maxUploads:
type: integer
description: Maximum uploads for file upload questions
accept:
type: string
description: The accepted file extension types for file upload questions
required:
type: boolean
description: Required value for the question
min:
type: integer
description: Minimum number allowed for a number type
max:
type: integer
description: Maximum number allowed for a number type
minlength:
type: integer
description: Minimum length of string allowed for a text type
maxlength:
type: integer
description: Maximum length of string allowed for a text type
options:
type: array
description: Array of possible options for a radio type
items:
type: object
properties:
name:
type: string
description: Text to show for option
value:
type: string
description: Key for option
dataPointDefinitionId:
type: integer
description: Use a data point definition to create a question.
x-access:
- administrator
- root
dataPointDefinition:
$ref: '#/components/schemas/DataPointDefinitionDeprecated'
required:
type: boolean
order:
type: integer
hideFromInfluencers:
type: boolean
RoutingDeprecated:
type: object
description: Routing configuration.
properties:
success:
$ref: '#/components/schemas/RoutingOptionsDeprecated'
not_eligible:
$ref: '#/components/schemas/RoutingOptionsDeprecated'
AudienceDeprecated:
type: object
x-access:
- root
- administrator
properties:
id:
type: integer
description: Unique identifier representing a single audience.
name:
type: string
description: Human-readable description of the audience displayed to administrators.
criteria:
type: array
items:
$ref: '#/components/schemas/InfluencerDataPointCriteriaDeprecated'
QuestionResponseDeprecated:
type: object
properties:
question:
$ref: '#/components/schemas/QuestionDeprecated'
value:
type: string
description: review question value
InstagramProfileDeprecated:
type: object
properties:
accessGrant:
type: object
properties:
isExpired:
type: boolean
type:
type: string
enum:
- basic
- business
averageComments:
type: integer
averageEngagements:
type: integer
averageLikes:
type: integer
audienceFakeCommentersLevel:
type: string
audienceFakeCommentersPercentage:
type: number
audienceFakeEngagersLevel:
type: string
audienceFakeFollowersLevel:
type: string
audienceFakeFollowersPercentage:
type: number
audienceFakeLikersLevel:
type: string
audienceFakeLikersPercentage:
type: number
audienceFraudLevel:
type: string
audiencePercentageFemale:
type: number
audiencePercentage_13_17:
type: number
audiencePercentage_18_24:
type: number
audiencePercentage_25_34:
type: number
audiencePercentage_35_44:
type: number
audiencePercentage_45_54:
type: number
audiencePercentage_55_64:
type: number
audiencePercentage_65_plus:
type: number
audiencePredominantAgeRange:
type: string
audiencePredominantCity:
type: string
audiencePredominantCountry:
type: string
bio:
type: string
boughtFollowers:
type: boolean
engagementRate:
type: number
id:
type: integer
isBusiness:
type: boolean
isPrivate:
type: boolean
followersCount:
type: integer
followingCount:
type: integer
fullName:
type: string
handle:
type: string
mediaCount:
type: integer
nudityLevel:
type: string
profanityLevel:
type: string
profilePicture:
type: string
profileType:
type: string
enum:
- business
- platform
sponsoredPostRate:
type: number
website:
type: string
NetworkSlug:
type: string
enum:
- blog
- facebook
- facebook_group
- facebook_live
- facebook_reel
- image
- instagram
- instagram_reel
- instagram_story
- linkedin
- pinterest
- snapchat_story
- tiktok
- twitch_stream
- twitter
- video
- youtube_video
- youtube_shorts
BazaarVoiceAppProductDeprecated:
type: object
properties:
reviewProductId:
type: integer
description: Product id assigned by Mavrck
externalBazaarProductId:
type: string
description: Product id assigned by BazaarVoice
DataPointDefinitionDeprecated:
type: object
required:
- name
- multi
- customSet
- type
properties:
id:
type: integer
description: Unique identifier for the data point.
key:
type: string
description: Key for the datapoint
name:
type: string
description: Display name for the data point.
description:
type: string
description: The description of the datapoint definition
x-access:
- root
- administrator
multi:
type: boolean
description: Boolean indicating whether multiple responses are allowed.
customSet:
type: boolean
description: Boolean indicating whether there is a custom set of responses, otherwise it is free-form.
type:
type: string
description: Type of the data point, e.g. string, integer_range.
markUpDescription:
type: string
description: The markup display description for the data point.
communityId:
type: integer
description: The communityId to which this data point definition belongs.
x-access:
- root
createdAt:
type: string
format: date-time
description: Date time data point created.
x-access:
- root
- administrator
updatedAt:
type: string
format: date-time
description: Date time data point updated.
x-access:
- root
- administrator
mergeTag:
type: boolean
description: 1 if the data point should be included as a merge tag, 0 otherwise
archived:
type: boolean
description: 1 if the data point is archived, 0 if it is not
setElements:
$ref: '#/components/schemas/DataPointDefinitionSetElementDeprecated'
membersCompleted:
type: integer
description: The count of members who have completed this data point.
x-access:
- administrator
actionGroups:
type: array
description: An array of live action groups that this datapoint is a part of
x-access:
- administrator
items:
type: object
properties:
id:
type: integer
title:
type: string
ActivationDeprecated:
type: object
properties:
id:
type: string
description: Unique identifier representing a single activation.
externalId:
type: string
description: Instagram external id
profilePicture:
type: string
description: Link to the user's Facebook profile picture using the External Facebook id of the user who created this activation.
membershipId:
type: integer
description: Community membership id of user who created this activation used that can be used for pulling up influencer profiles.
globalUserId:
type: integer
createdByAccountId:
type: string
description: Id of self-service application user who manually bound or manually entered this activation
updatedByAccountId:
type: string
description: Id of self-service application user who manually updated this activation
createdAt:
type: string
format: date-time
description: CREATED AT TIME
approvalStatus:
type: string
description: The Approval status of the activation.
points:
type: number
description: Number of points that the activation grants.
isApproved:
type: boolean
x-access:
- root
- administrator
description: Indicates whether this activation has been approved to be publicly available.
selfReported:
type: boolean
user:
type: object
properties:
id:
type:
- integer
- string
fullName:
type: string
firstName:
type: string
lastName:
type: string
profilePicture:
type: string
unverified:
type: string
enum:
- hidden
- emails
- excludes
country:
type: string
enum:
- Afghanistan
- Albania
- Algeria
- American Samoa
- Andorra
- Angola
- Anguilla
- Antarctica
- Antigua and Barbuda
- Argentina
- Armenia
- Aruba
- Australia
- Austria
- Azerbaijan
- Bahrain
- Bangladesh
- Barbados
- Belarus
- Belgium
- Belize
- Benin
- Bermuda
- Bhutan
- Bolivia
- Bosnia and Herzegovina
- Botswana
- Bouvet Island
- Brazil
- British Indian Ocean Territory
- British Virgin Islands
- Brunei
- Bulgaria
- Burkina Faso
- Burundi
- Cambodia
- Cameroon
- Canada
- Cape Verde
- Caribbean Netherlands
- Cayman Islands
- Central African Republic
- Chad
- Chile
- China
- Christmas Island
- Cocos (Keeling) Islands
- Collectivity of Saint Martin
- Colombia
- Comoros
- Cook Islands
- Costa Rica
- Côte d'Ivoire
- Croatia
- Cuba
- Curaçao
- Cyprus
- Czechia
- Democratic Republic of the Congo
- Denmark
- Djibouti
- Dominica
- Dominican Republic
- Ecuador
- Egypt
- El Salvador
- Equatorial Guinea
- Eritrea
- Estonia
- Ethiopia
- Falkland Islands (Malvinas)
- Faroe Islands
- Federated States of Micronesia
- Fiji
- Finland
- France
- French Guiana
- French Polynesia
- French Southern Territories
- Gabon
- Georgia
- Germany
- Ghana
- Gibraltar
- Greece
- Greenland
- Grenada
- Guadeloupe
- Guam
- Guatemala
- Guernsey
- Guinea
- Guinea-Bissau
- Guyana
- Haiti
- Heard Island and McDonald Islands
- Holy See (Vatican City)
- Honduras
- Hong Kong
- Hungary
- Iceland
- India
- Indonesia
- Iran
- Iraq
- Ireland
- Isle of Man
- Israel
- Jamaica
- Japan
- Italy
- Jersey
- Jordan
- Kazakhstan
- Kenya
- Kiribati
- Kuwait
- Kyrgyzstan
- Laos
- Latvia
- Lebanon
- Lesotho
- Liberia
- Libya
- Liechtenstein
- Lithuania
- Luxembourg
- Macau
- Macedonia (FYROM)
- Madagascar
- Malawi
- Malaysia
- Maldives
- Mali
- Malta
- Marshall Islands
- Martinique
- Mauritania
- Mauritius
- Mayotte
- Mexico
- Moldova
- Monaco
- Mongolia
- Montenegro
- Montserrat
- Morocco
- Mozambique
- Myanmar (Burma)
- Namibia
- Nauru
- Nepal
- Netherlands
- New Caledonia
- New Zealand
- Nicaragua
- Niger
- Nigeria
- Niue
- Norfolk Island
- North Korea
- Northern Mariana Islands
- Norway
- Oman
- Pakistan
- Palau
- Palestine
- Panama
- Papua New Guinea
- Paraguay
- Peru
- Philippines
- Pitcairn
- Poland
- Portugal
- Puerto Rico
- Qatar
- Republic of the Congo
- Reunion
- Romania
- Russia
- Rwanda
- Saint Helena, Ascension and Tristan da Cunha
- Saint Kitts and Nevis
- Saint Lucia
- Saint Pierre and Miquelon
- Saint Vincent and the Grenadines
- Saint-Barthélemy
- Samoa
- San Marino
- Sao Tome and Principe
- Saudi Arabia
- Senegal
- Serbia
- Seychelles
- Sierra Leone
- Singapore
- Sint Maarten (Dutch part)
- Slovakia
- Slovenia
- Solomon Islands
- Somalia
- South Africa
- South Georgia and the South Sandwich Islands
- South Korea
- South Sudan
- Spain
- Sri Lanka
- Sudan
- Suriname
- Svalbard and Jan Mayen
- Swaziland
- Sweden
- Switzerland
- Syria
- Taiwan
- Tajikistan
- Tanzania
- Thailand
- The Bahamas
- The Gambia
- Timor-Leste
- Togo
- Tokelau
- Tonga
- Trinidad and Tobago
- Tunisia
- Turkey
- Turkmenistan
- Turks and Caicos Islands
- Tuvalu
- U.S. Virgin Islands
- Uganda
- Ukraine
- United Arab Emirates
- United Kingdom
- United States Minor Outlying Islands
- United States
- Uruguay
- Uzbekistan
- Vanuatu
- Venezuela
- Vietnam
- Wallis and Futuna
- Western Sahara
- Yemen
- Zambia
- Zimbabwe
- Åland Islands
state:
type: string
city:
type: string
zip:
type: string
street:
type: string
apt:
type: string
phone:
type: string
age:
type: integer
gender:
type: string
enum:
- male
- female
- other
- non_bin
- describe
email:
type: string
talentManagerEmail:
type: string
registered:
type: boolean
birthday:
type: string
format: date
facebookProfile:
$ref: '#/components/schemas/FacebookProfileDeprecated'
instagramAccount:
$ref: '#/components/schemas/InstagramAccountDeprecated'
instagramProfile:
$ref: '#/components/schemas/InstagramProfileDeprecated'
tiktokCreator:
$ref: '#/components/schemas/TikTokCreatorDeprecated'
twitterAccount:
$ref: '#/components/schemas/TwitterAccountDeprecated'
pinterestAccount:
$ref: '#/components/schemas/PinterestAccountDeprecated'
youtubeChannel:
$ref: '#/components/schemas/YoutubeChannelDeprecated'
blog:
$ref: '#/components/schemas/Blog'
lists:
type: array
items:
type: object
properties:
id:
type: integer
label:
type: string
appMembership:
$ref: '#/components/schemas/MembershipDeprecated'
userContactInfo:
type: object
properties:
updatedAt:
type: string
format: date-time
emailIsVerified:
type: boolean
referralSlug:
type: string
referralCount:
type: string
gender:
type: string
genderDescription:
type: string
influencerTopics:
type: array
items:
$ref: '#/components/schemas/TopicDeprecated'
activations:
type: integer
engagements:
type: integer
clicksCount:
type: integer
conversionCount:
type: integer
conversionValue:
type: number
format: double
rewards:
type: integer
facebookPostsCount:
type: integer
instagramPostsCount:
type: integer
twitterPostsCount:
type: integer
pinterestPostsCount:
type: integer
membershipDataPoints:
type: array
items:
type: object
properties:
dataPointDefinition:
$ref: '#/components/schemas/DataPointDefinitionDeprecated'
lastEditedBy:
type: string
updatedAt:
type: string
format: date-time
value:
type: array
items:
type: string
membershipCostAndPerformance:
$ref: '#/components/schemas/MembershipCostAndPerformanceDeprecated'
audiencePredominantAgeRange:
type: string
audiencePredominantCountry:
type: string
audiencePredominantCity:
type: string
audiencePercentageFemale:
type: number
audiencePercentage_13_17:
type: number
audiencePercentage_18_24:
type: number
audiencePercentage_25_34:
type: number
audiencePercentage_35_44:
type: number
audiencePercentage_45_54:
type: number
audiencePercentage_55_64:
type: number
audiencePercentage_65_plus:
type: number
cpe:
type: number
cpm:
type: number
cpp:
type: number
audienceFraudLevel:
type: string
enum:
- low
- medium
- high
audienceFakeFollowersLevel:
type: string
enum:
- low
- medium
- high
audienceFakeEngagersLevel:
type: string
enum:
- low
- medium
- high
nudityLevel:
type: string
enum:
- low
- medium
- high
violenceLevel:
type: string
enum:
- low
- medium
- high
profanityLevel:
type: string
enum:
- low
- medium
- high
hasPublicSummaryRecord:
type: boolean
action:
$ref: '#/components/schemas/ActionDeprecated'
content:
$ref: '#/components/schemas/ActivationContentDeprecated'
instagramAccount:
$ref: '#/components/schemas/InstagramAccountDeprecated'
facebookProfile:
$ref: '#/components/schemas/FacebookProfileDeprecated'
twitterAccount:
$ref: '#/components/schemas/TwitterAccountDeprecated'
pinterestAccount:
$ref: '#/components/schemas/PinterestAccountDeprecated'
contactInfo:
$ref: '#/components/schemas/MembershipContactInfoDeprecated'
membership:
$ref: '#/components/schemas/MembershipDeprecated'
campaign:
$ref: '#/components/schemas/CampaignDeprecated'
surveyResponses:
type: array
items:
$ref: '#/components/schemas/UserQuestionResponse'
reviewContent:
$ref: '#/components/schemas/ReviewFormResponseDeprecated'
validation:
type: object
properties:
ftcStatus:
type: string
enum:
- unknown
- valid
- invalid
brandedContentTagIGHandle:
type: string
description: A business partner that an influencer tagged in their Partnership Ads posts.
tikTokHandle:
type: string
description: TikTok username handle
tikTokMetrics:
type: object
tags:
type: array
items:
type: string
exportFilenames:
type: array
items:
type: string
DataPointDefinitionSetElementDeprecated:
type: array
items:
type: object
properties:
id:
type: integer
description: Unique identifier for the data point set element.
key:
type: string
displayLabel:
type: string
markUpDisplayLabel:
type: string
ProductDeprecated:
type: object
properties:
id:
type: integer
description: id of the product
title:
type: string
description: title of the product
description:
type: string
description: Description of product
image:
type: string
description: product image url
communityId:
type: string
description: instance to which this product belongs
bazaarVoiceAppProduct:
$ref: '#/components/schemas/BazaarVoiceAppProductDeprecated'
powerReviewsPage:
$ref: '#/components/schemas/PowerReviewsPageDeprecated'
yotpoAppProduct:
$ref: '#/components/schemas/YotpoAppProductDeprecated'
PinterestAccountDeprecated:
type: object
properties:
id:
description: int = mavck-db-id, string = derived-index-id
type:
- integer
- string
username:
type: string
firstName:
type: string
lastName:
type: string
profilePicture:
type: string
bio:
type: string
followersCount:
type: integer
followingCount:
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-datasubjectrequest-api-openapi.yml