Mavrck Global Users API
The GlobalUsers API from Mavrck — 2 operation(s) for globalusers.
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 Global Users API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: GlobalUsers
paths:
/global-user/{globalUserId}/lists:
get:
tags:
- GlobalUsers
operationId: getListsForGlobalUser
x-handler: global_user_lists/global_user_list_controller.js
x-access:
- administrator
summary: Retrieve all lists associated with this global user.
parameters:
- name: globalUserId
in: path
required: true
schema:
type: integer
- name: isArchived
in: query
required: false
schema:
type: boolean
- $ref: '#/components/parameters/orderByParam'
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/offsetParam'
responses:
'200':
description: A collection of lists.
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseMetadata'
data:
type: array
items:
$ref: '#/components/schemas/GlobalUserList'
'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: Action not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/global-users/summary:
get:
tags:
- GlobalUsers
operationId: getGlobalUsersSummary
x-handler: global_users_summary/global_users_summary_controller.js
x-access:
- administrator
- root
summary: Retrieve summary of global users.
parameters:
- $ref: '#/components/parameters/userFilter'
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/searchKeywords'
responses:
'200':
description: A summary of global users data.
content:
application/json:
schema:
type: object
properties:
avg_metrics:
type: object
properties:
members:
type: integer
totalReach:
type: number
averageFollowers:
type: number
averageEngagementRate:
type: number
top_influencers:
type: array
items:
$ref: '#/components/schemas/GlobalUserDeprecated'
topics:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
gender_age:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
country:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
audience_gender:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
fraud_levels:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
audience_country:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
audience_city:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
audience_age:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
reach:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
top_hashtags:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Age_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_BrandInfluences_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_City_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Country_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_EducationOrganization_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_EducationStatus_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Employer_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Favorite_MusicBands_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Favorite_MusicGenre_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Favorite_MusicSoloArtist_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Gender_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Industry_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Language_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_LikesAndInterests_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_MaritalStatus_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_ParentalStatus_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_MediaInfluences_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Occupation_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_PeopleInfluences_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_PersonalIncome_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_Race_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_SportTeamSupported_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_SportsFollowed_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
DemographicsPro_Audience_State_Max:
type: array
items:
type: object
properties:
display:
type: string
value:
type: number
'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'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
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.
ResponseMetadata:
properties:
limit:
type: number
format: double
offset:
type: number
format: double
status:
type: string
enum:
- failure
- success
totalCount:
type: number
format: double
type: object
additionalProperties: false
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
PreviewPostDeprecated:
type: object
properties:
id:
type: integer
postId:
type: string
network:
type: string
likes:
type: integer
comments:
type: integer
views:
type: integer
shares:
type: integer
caption:
type: string
imageUrl:
type: string
link:
type: string
isSponsored:
type: boolean
mentions:
type: array
items:
type: string
activation:
$ref: '#/components/schemas/ActivationDeprecated'
postedTime:
type: string
format: date-time
visualSafeSearch:
$ref: '#/components/schemas/VisualSafeSearchDeprecated'
textSafeSearch:
$ref: '#/components/schemas/TextSafeSearchDeprecated'
BazaarVoiceAppProductDeprecated:
type: object
properties:
reviewProductId:
type: integer
description: Product id assigned by Mavrck
externalBazaarProductId:
type: string
description: Product id assigned by BazaarVoice
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
# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-globalusers-api-openapi.yml