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 User Lists API servers: - url: http://app.splashscore.com/v1 - url: https://app.splashscore.com/v1 security: - apiKey: [] tags: - name: GlobalUserLists paths: /action-groups/{id}/candidates/global-user-lists/{globalUserListId}/members: post: tags: - GlobalUserLists operationId: createGlobalUserListMemberFromCandidates x-handler: global_user_lists/global_user_list_member_controller.js x-access: - administrator summary: Add candidates of an action group to a global user list. parameters: - name: id in: path required: true description: Unique identifier of the action group that influencers are candidates of. schema: type: string - name: globalUserListId in: path required: true schema: type: integer responses: '200': description: Members added successfully. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list 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: globalUserIds: type: array items: type: integer queryFilter: $ref: '#/components/schemas/ActionGroupCandidateQueryFilter' required: true put: tags: - GlobalUserLists operationId: moveGlobalUserListMemberFromCandidates x-handler: global_user_lists/global_user_list_member_controller.js x-access: - administrator summary: Move candidates of an action group from one global user list to another. parameters: - name: id in: path required: true description: Unique identifier of the action group that influencers are candidates of. schema: type: string - name: globalUserListId in: path required: true schema: type: integer responses: '200': description: Members moved successfully. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list 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 required: - fromGlobalUserListIds properties: fromGlobalUserListIds: type: array items: type: integer globalUserIds: type: array items: type: integer queryFilter: $ref: '#/components/schemas/ActionGroupCandidateQueryFilter' required: true /action-groups/{id}/candidates/global-user-lists/members/remove: post: tags: - GlobalUserLists operationId: deleteGlobalUserListMemberFromCandidates x-handler: global_user_lists/global_user_list_member_remove_controller.js x-access: - administrator summary: Remove candidates of an action group from global user lists. parameters: - name: id in: path required: true description: Unique identifier of the action group that influencers are candidates of. schema: type: string responses: '200': description: Members removed successfully. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list 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 required: - globalUserListId properties: globalUserListId: type: array items: type: integer globalUserIds: type: array items: type: integer queryFilter: $ref: '#/components/schemas/ActionGroupCandidateQueryFilter' required: true /global-user-lists: get: tags: - GlobalUserLists operationId: getGlobalUserLists x-handler: global_user_lists/global_user_list_controller.js x-access: - administrator summary: Retrieve global user lists. parameters: - $ref: '#/components/parameters/orderByParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/offsetParam' - $ref: '#/components/parameters/labelParam' - name: isArchived in: query required: false schema: type: boolean responses: '200': description: Collection of global user 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' '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/Error' post: tags: - GlobalUserLists operationId: createGlobalUserList x-handler: global_user_lists/global_user_list_controller.js x-access: - administrator summary: Create a global user list. responses: '200': description: GlobalUserList URI. content: application/json: schema: type: object properties: id: type: integer '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' requestBody: content: application/json: schema: type: object required: - label properties: label: type: string minLength: 1 maxLength: 50 required: true /global-user-lists/{id}: get: tags: - GlobalUserLists operationId: getGlobalUserListById x-handler: global_user_lists/global_user_list_controller.js x-access: - administrator summary: Retrieve a single global user list. parameters: - name: id in: path required: true schema: type: integer responses: '200': description: A single global user list. content: application/json: schema: $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: Global user list not found. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/Error' put: tags: - GlobalUserLists operationId: updateGlobalUserList x-handler: global_user_lists/global_user_list_controller.js x-access: - administrator summary: Update a global user list. parameters: - name: id in: path required: true schema: type: integer responses: '200': description: Update successful. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list 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: $ref: '#/components/schemas/GlobalUserList' required: true delete: tags: - GlobalUserLists operationId: destroyGlobalUserList x-handler: global_user_lists/global_user_list_controller.js x-access: - administrator summary: Delete a global user list. parameters: - name: id in: path required: true schema: type: integer responses: '200': description: Delete successful. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list not found. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/Error' /global-user-lists/{id}/archive: post: tags: - GlobalUserLists operationId: archiveGlobalUserList x-handler: global_user_lists/global_user_list_definition_archive_controller.js x-access: - administrator summary: Archive a global user list. parameters: - name: id in: path required: true schema: type: integer responses: '200': description: Archive successful. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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' /global-user-lists/{id}/unarchive: post: tags: - GlobalUserLists operationId: unarchiveGlobalUserList x-handler: global_user_lists/global_user_list_definition_unarchive_controller.js x-access: - administrator summary: Unarchive a global user list. parameters: - name: id in: path required: true schema: type: integer responses: '200': description: Unarchive successful. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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' /global-user-lists/{globalUserListId}/members: post: tags: - GlobalUserLists operationId: createGlobalUserListMember x-handler: global_user_lists/global_user_list_member_controller.js x-access: - administrator summary: Add members to a global user list. parameters: - name: globalUserListId in: path required: true schema: type: integer responses: '200': description: Members added successfully. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list 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: globalUserIds: type: array items: type: integer searchState: type: object description: Capture Search State for analytics queryFilter: $ref: '#/components/schemas/UserQueryFilter' required: true put: tags: - GlobalUserLists operationId: moveGlobalUserListMember x-handler: global_user_lists/global_user_list_member_controller.js x-access: - administrator summary: Move members from one global user list to another. parameters: - name: globalUserListId in: path required: true schema: type: integer responses: '200': description: Members moved successfully. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list 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 required: - fromGlobalUserListIds properties: fromGlobalUserListIds: type: array items: type: integer globalUserIds: type: array items: type: integer queryFilter: $ref: '#/components/schemas/UserQueryFilter' required: true /global-user-lists/members-remove: post: tags: - GlobalUserLists operationId: deleteGlobalUserListMember x-handler: global_user_lists/global_user_list_member_remove_controller.js x-access: - administrator summary: Remove members from global user lists. responses: '200': description: Members removed successfully. content: application/json: schema: $ref: '#/components/schemas/EmptyObject' '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: Global user list 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 required: - globalUserListId properties: globalUserListId: type: array items: type: integer globalUserIds: type: array items: type: integer queryFilter: $ref: '#/components/schemas/UserQueryFilter' required: true components: schemas: 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 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. UserSearch: type: object additionalProperties: false properties: DemographicsPro_Audience_Data_Analysis: type: object additionalProperties: false properties: DemographicsPro_Audience_Gender_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_MaritalStatus_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_ParentalStatus_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Age_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Race_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Language_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Country_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_State_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_City_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_EducationStatus_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_PersonalIncome_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Occupation_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Industry_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Employer_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_EducationOrganization_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_LikesAndInterests_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_PeopleInfluences_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_MediaInfluences_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_BrandInfluences_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Favorite_MusicGenre_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Favorite_MusicSoloArtist_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Favorite_MusicBands_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_SportsFollowed_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_SportTeamSupported_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_BrandInfluences_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Country_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Gender_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Age_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Race_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Language_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Data_Analysis_Facebook: type: object additionalProperties: false properties: DemographicsPro_Audience_Gender_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Country_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_City_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Age_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Data_Analysis_TikTok: type: object additionalProperties: false properties: DemographicsPro_Audience_Gender_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_MaritalStatus_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_ParentalStatus_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Age_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Race_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Language_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Country_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_State_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_City_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_EducationStatus_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_PersonalIncome_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Occupation_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Industry_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Employer_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_EducationOrganization_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_LikesAndInterests_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_PeopleInfluences_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_MediaInfluences_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_BrandInfluences_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Favorite_MusicGenre_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Favorite_MusicSoloArtist_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Favorite_MusicBands_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_SportsFollowed_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_SportTeamSupported_Max: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Gender_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Age_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Race_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Language_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_Country_All: type: object additionalProperties: false x-filter-type: multiTerm properties: ids: type: array items: type: - integer - string range: type: object additionalProperties: false properties: $gte: type: number $lte: type: number DemographicsPro_Audience_State_All: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_City_All: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string DemographicsPro_Audience_Data_Analysis_Snapchat: type: object additionalProperties: false properties: DemographicsPro_Audience_Age_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Country_Max: type: array x-filter-type: term items: type: string DemographicsPro_Audience_Gender_Max: type: array x-filter-type: term items: type: string memberSelectedEthnicities: type: object additionalProperties: false properties: ethnicGroup: type: array x-filter-type: term items: type: string dataPoints: type: object x-filter-type: terms instagramAccount: type: object additionalProperties: false properties: isBusiness: type: boolean x-filter-type: boolean isPrivate: type: boolean x-filter-type: boolean handle: type: array x-filter-type: term items: type: string followersCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageLikes: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageComments: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageEngagements: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number engagementRate: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number facebookProfile: type: object additionalProperties: false properties: reach: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageLikes: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageComments: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageEngagements: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number engagementRate: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number tiktokCreator: type: object additionalProperties: false properties: status: type: array x-filter-type: term items: type: string audiencePredominantAgeRange: type: array x-filter-type: term items: type: string audiencePredominantCountry: type: array x-filter-type: term items: type: string audiencePredominantDevice: type: array x-filter-type: term items: type: string audiencePredominantGender: type: array x-filter-type: term items: type: string audiencePredominantLocale: type: array x-filter-type: term items: type: string followersCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number engagementRate: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number accountType: type: array x-filter-type: term items: type: string enum: - Business - Brand - Creator - Influencer twitterAccount: type: object additionalProperties: false properties: followersCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageFavorites: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageRetweets: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageEngagements: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number engagementRate: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number pinterestAccount: type: object additionalProperties: false properties: followersCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number monthlyViewers: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number averageEngagements: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number engagementRate: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number boardsCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number pinsCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number appMembership: type: object additionalProperties: false properties: totalImpressions: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number lifetimeClicks: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number lifetimeConversions: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number lifetimeConversionsValue: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number mostRecentActivationDate: type: object additionalProperties: false x-filter-type: range properties: $gte: type: string format: date registeredInfluencer: type: object additionalProperties: false hasPosted: type: object additionalProperties: false blog: type: object x-filter-type: exists additionalProperties: false youtubeChannel: type: object x-filter-type: exists additionalProperties: false properties: followersCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number snapchatAccount: type: object x-filter-type: exists additionalProperties: false properties: followersCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number engagementRate: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number profileTier: type: array x-filter-type: term items: type: string enum: - TIER_STANDARD - TIER_PUBLIC_OFFICIAL - TIER_PUBLIC profileType: type: array x-filter-type: term items: type: string enum: - Emerging Creator - Snap Star - Business - Official Business shareAuthorizedDataWithApiPartners: type: boolean additionalProperties: false x-filter-type: boolean customInfluencerStatusId: type: object additionalProperties: true dueDate: type: object additionalProperties: true audienceLocation: type: object x-filter-type: $or additionalProperties: false properties: audiencePredominantCity: type: array items: type: string audiencePredominantCountry: type: array items: type: string hasSponsoredContent: type: object x-filter-type: $or properties: instagramPost.isSponsored: type: array items: type: boolean tiktokPosts.isSponsored: type: array items: type: boolean globalPerformanceComposites: type: array items: type: object properties: fields: type: array items: type: string enum: - emv - roi - cpp - cpe - cpm - sponsoredContentEmv - sponsoredContentRoi - sponsoredContentCpp - sponsoredContentCpe - sponsoredContentCpm payload: x-filter-type: range properties: $gte: type: number $lte: type: number globalPerformanceMetrics: type: object additionalProperties: false properties: emv: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number roi: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number cpp: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number cpe: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number cpm: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number sponsoredContentEmv: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number sponsoredContentRoi: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number sponsoredContentCpp: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number sponsoredContentCpe: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number sponsoredContentCpm: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number costPerMavelyLinkClick: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number hasTrackingOrAffiliateLinksData: type: boolean additionalProperties: false x-filter-type: boolean brandsCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number campaignsCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number boundContentCount: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number city: type: string x-filter-type: text unverified: type: array x-filter-type: term items: type: string enum: - hidden - emails - excludes country: type: array x-filter-type: term items: 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 gender: type: array x-filter-type: term items: type: string enum: - male - female - other - non_bin - describe state: type: array x-filter-type: term items: type: string zip: type: array x-filter-type: term items: type: string audiencePredominantCountry: type: array x-filter-type: term items: type: string audiencePredominantAgeRange: type: array x-filter-type: term items: type: string audiencePredominantCity: type: array x-filter-type: term items: type: string audienceFraudLevel: type: array x-filter-type: term items: type: string enum: - low - medium - high age: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number birthday: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number audiencePercentageFemale: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number cpe: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number cpm: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number cpp: type: object additionalProperties: false x-filter-type: range properties: $gte: type: number $lte: type: number lists: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string topics: type: object additionalProperties: false x-filter-type: multiTerm properties: quantifier: type: string enum: - any - all ids: type: array items: type: - integer - string GlobalUserList: type: object required: - label properties: id: type: integer label: type: string minLength: 1 maxLength: 50 createdAt: type: string format: date-time LinksDeprecated: type: object x-access: - anonymous - influencer properties: normal: type: string description: A normal link to an entity. deep: type: string description: A deep link to the entity. EmptyObject: type: object properties: {} ActionGroupCandidateQueryFilter: type: object required: - expectedNumberOfInfluencers properties: userFilter: $ref: '#/components/schemas/UserSearch' q: type: string description: Search parameter. statusId: type: array items: type: integer workflowStageId: type: integer customStatusId: type: array items: type: - integer - string customInfluencerStatusId: type: array items: type: - integer - string dueDate: type: array items: type: - string completed: type: boolean optedIn: type: integer participating: type: array items: type: - integer - string excludedGlobalUserIds: type: array items: type: integer expectedNumberOfInfluencers: type: integer orderProperty: type: string enum: - statusId - upvotes - downvotes - netVotes - totalVotes - dueDate - optedInDate - engagements - createdAt - customStatusId - customInfluencerStatusId - quote - user.stageJoinDate - user.id - user.age - user.audienceFakeEngagersLevel - user.audienceFakeFollowersLevel - user.audienceFraudLevel - user.audiencePercentageFemale - user.audiencePercentage_13_17 - user.audiencePercentage_18_24 - user.audiencePercentage_25_34 - user.audiencePercentage_35_44 - user.audiencePercentage_45_54 - user.audiencePercentage_55_64 - user.audiencePercentage_65_plus - user.audiencePredominantAgeRange - user.audiencePredominantCity - user.audiencePredominantCountry - user.birthday - user.city - user.country - user.deleted - user.email - user.fullName - user.gender - user.instagramHandle - user.lastRefreshedAt - user.loadSource - user.nudityLevel - user.profanityLevel - user.state - user.violenceLevel - listMemberCostAndPerformance.listMemberId - listMemberCostAndPerformance.rewards - listMemberCostAndPerformance.value - listMemberCostAndPerformance.cost - listMemberCostAndPerformance.posts - listMemberCostAndPerformance.engagements - listMemberCostAndPerformance.impressions - listMemberCostAndPerformance.clicks - listMemberCostAndPerformance.conversions - listMemberCostAndPerformance.conversionValue - listMemberCostAndPerformance.cpm - listMemberCostAndPerformance.cpp - listMemberCostAndPerformance.cpe - listMemberCostAndPerformance.committedAmount - listMemberCostAndPerformance.readyAmount - listMemberCostAndPerformance.paidAmount - listMemberCostAndPerformance.emvValue - listMemberCostAndPerformance.roiValue - user.instagramAccount.globalUserId - user.instagramAccount.analysisVersion - user.instagramAccount.audienceFakeCommentersLevel - user.instagramAccount.audienceFakeCommentersPercentage - user.instagramAccount.audienceFakeEngagersLevel - user.instagramAccount.audienceFakeFollowersLevel - user.instagramAccount.audienceFakeFollowersPercentage - user.instagramAccount.audienceFakeLikersLevel - user.instagramAccount.audienceFakeLikersPercentage - user.instagramAccount.audienceFraudLevel - user.instagramAccount.audiencePercentageFemale - user.instagramAccount.audiencePercentage_13_17 - user.instagramAccount.audiencePercentage_18_24 - user.instagramAccount.audiencePercentage_25_34 - user.instagramAccount.audiencePercentage_35_44 - user.instagramAccount.audiencePercentage_45_54 - user.instagramAccount.audiencePercentage_55_64 - user.instagramAccount.audiencePercentage_65_plus - user.instagramAccount.audiencePredominantAgeRange - user.instagramAccount.audiencePredominantCity - user.instagramAccount.audiencePredominantCountry - user.instagramAccount.averageComments - user.instagramAccount.averageEngagements - user.instagramAccount.averageLikes - user.instagramAccount.bio - user.instagramAccount.boughtFollowers - user.instagramAccount.createdAt - user.instagramAccount.engagementRate - user.instagramAccount.followersCount - user.instagramAccount.followingCount - user.instagramAccount.fullName - user.instagramAccount.handle - user.instagramAccount.instagramExternalId - user.instagramAccount.instagramProfileId - user.instagramAccount.isBusiness - user.instagramAccount.isPrivate - user.instagramAccount.lastAnalyzedAt - user.instagramAccount.lastAnalyzedFollowersFraudAt - user.instagramAccount.loadSource - user.instagramAccount.mediaCount - user.instagramAccount.nudityLevel - user.instagramAccount.previewPostsLastUpdatedAt - user.instagramAccount.profanityLevel - user.instagramAccount.profilePicture - user.instagramAccount.profileType - user.instagramAccount.sourceDetail - user.instagramAccount.sponsoredPostRate - user.instagramAccount.topicsLastAnalyzedAt - user.instagramAccount.updatedAt - user.instagramAccount.violenceLevel - user.instagramAccount.website - user.facebookProfile.id - user.facebookProfile.averageComments - user.facebookProfile.averageEngagements - user.facebookProfile.averageLikes - user.facebookProfile.engagementRate - user.facebookProfile.facebookExternalId - user.facebookProfile.facebookCreator - user.facebookProfile.link - user.facebookProfile.name - user.facebookProfile.picture - user.facebookProfile.reach - user.facebookProfile.type - user.twitterAccount.id - user.twitterAccount.userId - user.twitterAccount.handle - user.twitterAccount.fullName - user.twitterAccount.profilePicture - user.twitterAccount.description - user.twitterAccount.followersCount - user.twitterAccount.followingCount - user.twitterAccount.listedCount - user.twitterAccount.accountCreatedAt - user.twitterAccount.location - user.twitterAccount.geoEnabled - user.twitterAccount.lang - user.twitterAccount.timeZone - user.twitterAccount.utcOffset - user.twitterAccount.verified - user.twitterAccount.protected - user.twitterAccount.averageFavorites - user.twitterAccount.averageRetweets - user.twitterAccount.averageEngagements - user.twitterAccount.engagementRate - user.twitterAccount.primaryAccount - user.twitterAccount.twitterExternalId - user.twitterAccount.createdAt - user.pinterestAccount.id - user.pinterestAccount.averageEngagements - user.pinterestAccount.bio - user.pinterestAccount.boardsCount - user.pinterestAccount.createdAt - user.pinterestAccount.engagementRate - user.pinterestAccount.externalId - user.pinterestAccount.firstName - user.pinterestAccount.followersCount - user.pinterestAccount.followingCount - user.pinterestAccount.lastName - user.pinterestAccount.monthlyViewers - user.pinterestAccount.pinsCount - user.pinterestAccount.primaryAccount - user.pinterestAccount.profilePicture - user.pinterestAccount.updatedAt - user.pinterestAccount.userId - user.pinterestAccount.username - user.blog.id - user.blog.globalUserId - user.blog.language - user.blog.name - user.blog.platform - user.blog.url - user.youtubeChannel.id - user.youtubeChannel.userId - user.youtubeChannel.username - user.youtubeChannel.bio - user.youtubeChannel.accountCreatedAt - user.youtubeChannel.profilePicture - user.youtubeChannel.followersCount - user.youtubeChannel.videoCount - user.youtubeChannel.commentCount - user.youtubeChannel.viewCount - user.youtubeChannel.primaryAccount - user.youtubeChannel.youtubeExternalId - user.youtubeChannel.handle - user.youtubeChannel.global_user_id - draftContent.id - draftContent.text - draftContent.listMemberId - draftContent.createdAt - draftContent.updatedAt - draftContent.status - draftContent.contentType - draftContent.notes - draftContent.contentUrl - draftContent.isArchived - draftContent.archivedByAccountId - draftContent.archivedByGlobalUserId - draftContent.archivedAt - draftContent.threadId - draftContent.feedback - draftContent.uploaderType - draftContent.uploaderAccountId - draftContent.uploaderGlobalUserId - user.tiktokCreator.followersCount - user.tiktokCreator.engagementRate UserQueryFilter: type: object required: - expectedNumberOfInfluencers properties: userFilter: $ref: '#/components/schemas/UserSearch' q: type: string description: Search parameter. excludedGlobalUserIds: type: array items: type: integer expectedNumberOfInfluencers: type: integer searchKeywords: type: string orderProperty: type: string enum: - createdAt - id - age - audienceFakeEngagersLevel - audienceFakeFollowersLevel - audienceFraudLevel - audiencePercentageFemale - audiencePercentage_13_17 - audiencePercentage_18_24 - audiencePercentage_25_34 - audiencePercentage_35_44 - audiencePercentage_45_54 - audiencePercentage_55_64 - audiencePercentage_65_plus - audiencePredominantAgeRange - audiencePredominantCity - audiencePredominantCountry - birthday - city - country - deleted - email - fullName - gender - instagramHandle - lastRefreshedAt - loadSource - nudityLevel - profanityLevel - state - violenceLevel - instagramAccount.globalUserId - instagramAccount.analysisVersion - instagramAccount.audienceFakeCommentersLevel - instagramAccount.audienceFakeCommentersPercentage - instagramAccount.audienceFakeEngagersLevel - instagramAccount.audienceFakeFollowersLevel - instagramAccount.audienceFakeFollowersPercentage - instagramAccount.audienceFakeLikersLevel - instagramAccount.audienceFakeLikersPercentage - instagramAccount.audienceFraudLevel - instagramAccount.audiencePercentageFemale - instagramAccount.audiencePercentage_13_17 - instagramAccount.audiencePercentage_18_24 - instagramAccount.audiencePercentage_25_34 - instagramAccount.audiencePercentage_35_44 - instagramAccount.audiencePercentage_45_54 - instagramAccount.audiencePercentage_55_64 - instagramAccount.audiencePercentage_65_plus - instagramAccount.audiencePredominantAgeRange - instagramAccount.audiencePredominantCity - instagramAccount.audiencePredominantCountry - instagramAccount.averageComments - instagramAccount.averageEngagements - instagramAccount.averageLikes - instagramAccount.bio - instagramAccount.boughtFollowers - instagramAccount.createdAt - instagramAccount.engagementRate - instagramAccount.followersCount - instagramAccount.followingCount - instagramAccount.fullName - instagramAccount.handle - instagramAccount.instagramExternalId - instagramAccount.instagramProfileId - instagramAccount.isBusiness - instagramAccount.isPrivate - instagramAccount.lastAnalyzedAt - instagramAccount.lastAnalyzedFollowersFraudAt - instagramAccount.loadSource - instagramAccount.mediaCount - instagramAccount.nudityLevel - instagramAccount.previewPostsLastUpdatedAt - instagramAccount.profanityLevel - instagramAccount.profilePicture - instagramAccount.profileType - instagramAccount.sourceDetail - instagramAccount.sponsoredPostRate - instagramAccount.topicsLastAnalyzedAt - instagramAccount.updatedAt - instagramAccount.violenceLevel - instagramAccount.website - facebookProfile.id - facebookProfile.averageComments - facebookProfile.averageEngagements - facebookProfile.averageLikes - facebookProfile.engagementRate - facebookProfile.facebookExternalId - facebookProfile.facebookCreator - facebookProfile.link - facebookProfile.name - facebookProfile.picture - facebookProfile.reach - facebookProfile.type - twitterAccount.id - twitterAccount.userId - twitterAccount.handle - twitterAccount.fullName - twitterAccount.profilePicture - twitterAccount.description - twitterAccount.followersCount - twitterAccount.followingCount - twitterAccount.listedCount - twitterAccount.accountCreatedAt - twitterAccount.location - twitterAccount.geoEnabled - twitterAccount.lang - twitterAccount.timeZone - twitterAccount.utcOffset - twitterAccount.verified - twitterAccount.protected - twitterAccount.averageFavorites - twitterAccount.averageRetweets - twitterAccount.averageEngagements - twitterAccount.engagementRate - twitterAccount.primaryAccount - twitterAccount.twitterExternalId - twitterAccount.createdAt - pinterestAccount.id - pinterestAccount.averageEngagements - pinterestAccount.bio - pinterestAccount.boardsCount - pinterestAccount.createdAt - pinterestAccount.engagementRate - pinterestAccount.externalId - pinterestAccount.firstName - pinterestAccount.followersCount - pinterestAccount.followingCount - pinterestAccount.lastName - pinterestAccount.monthlyViewers - pinterestAccount.pinsCount - pinterestAccount.primaryAccount - pinterestAccount.profilePicture - pinterestAccount.updatedAt - pinterestAccount.userId - pinterestAccount.username - blog.id - blog.globalUserId - blog.language - blog.name - blog.platform - blog.url - youtubeChannel.id - youtubeChannel.userId - youtubeChannel.username - youtubeChannel.bio - youtubeChannel.accountCreatedAt - youtubeChannel.profilePicture - youtubeChannel.followersCount - youtubeChannel.videoCount - youtubeChannel.commentCount - youtubeChannel.viewCount - youtubeChannel.primaryAccount - youtubeChannel.youtubeExternalId - youtubeChannel.handle - youtubeChannel.global_user_id - user.stageJoinDate parameters: limitParam: in: query description: Maximum number of items to return name: limit schema: type: integer orderByParam: in: query description: Attribute to order by. name: orderBy schema: type: string offsetParam: in: query description: Number of items to skip name: offset schema: type: integer labelParam: name: label in: query required: false schema: type: string securitySchemes: apiKey: type: apiKey name: api-key in: header