> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Utm Parameters
> Get all UTM parameters for a given person.
NsApiSlow threshold: 2000 ms.
## OpenAPI
````yaml /openapi/agent/openapi-v3-PersonAgent.json post /api/v1/Agents/Person/GetUtmParameters
openapi: 3.0.0
info:
version: v1-Agents
title: SuperOffice Agent API v1
description: SuperOffice Agent API - PersonAgent
contact:
name: SuperOffice DevNet
url: https://docs.superoffice.com/en/api/index.html
email: sdk@superoffice.com
servers:
- url: http://localhost:56350
- url: https://localhost:56350
security: []
tags: []
externalDocs:
description: >-
The SuperOffice DevNet Community has more documentation, examples, and
discussion forums.
url: https://community.superoffice.com/en/developer/
paths:
/api/v1/Agents/Person/GetUtmParameters:
post:
tags:
- Person_Agent
summary: Get Utm Parameters
description: |-
Get all UTM parameters for a given person.
NsApiSlow threshold: 2000 ms.
operationId: v1PersonAgent_GetUtmParameters
parameters:
- name: $select
in: query
description: >-
Optional comma separated list of properties to include in the
result. Other fields are then nulled out to reduce payload size:
"Name,department,category". Default = show all fields.
required: false
schema:
type: string
- name: Accept-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
required: false
schema:
type: string
- name: SO-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
required: false
schema:
type: string
- name: SO-Culture
in: header
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
required: false
schema:
type: string
- name: SO-TimeZone
in: header
description: >-
Specify the timezone code that you would like date/time responses
converted to.
required: false
schema:
type: string
- name: SO-AppToken
in: header
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest
text/json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest
application/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest
text/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest
application/x-www-form-urlencoded:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest
application/json-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest
application/merge-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest
description: PersonId
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.UtmParameters'
text/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.UtmParameters'
application/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.UtmParameters'
text/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.UtmParameters'
application/json-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.UtmParameters'
application/merge-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.UtmParameters'
security:
- SuperOffice_Password: []
SuperId_Authentication: []
components:
schemas:
SuperOffice.WebApi.v1.Carriers.PersonCarriers.GetUtmParametersRequest:
description: 'GetUtmParameters: Get all UTM parameters for a given person.'
type: object
properties:
PersonId:
format: int32
type: integer
SuperOffice.CRM.Services.UtmParameters:
description: "Utm parameters for a given person.\r\n\r\nCarrier object for UtmParameters.\r\nServices for the UtmParameters Carrier is available from the Person Agent."
type: object
properties:
UtmParametersId:
format: int32
description: Primary key
type: integer
CreatedContactId:
format: int32
description: Id of the created contact
type: integer
CreatedPersonId:
format: int32
description: Id of the created person
type: integer
FormSubmissionId:
format: int32
description: Id of the form submission
type: integer
FirstTouchSource:
description: First touch UTM source
type: string
FirstTouchMedium:
description: First touch UTM medium
type: string
FirstTouchCampaign:
description: First touch UTM campaign
type: string
FirstTouchTerm:
description: First touch UTM term
type: string
FirstTouchContent:
description: First touch UTM content
type: string
FirstTouchReferrerDomain:
description: First touch UTM referrer domain
type: string
FirstTouchWhen:
format: date-time
description: First touch date
type: string
Source:
description: UTM source
type: string
Medium:
description: UTM medium
type: string
Campaign:
description: UTM campaign
type: string
Term:
description: UTM term
type: string
Content:
description: UTM content
type: string
ReferrerDomain:
description: UTM referrer domain
type: string
When:
format: date-time
description: Date of the visit or form submission
type: string
Registered:
format: date-time
description: Registered when in UTC.
type: string
RegisteredAssociateId:
format: int32
description: Registered by whom
type: integer
Updated:
format: date-time
description: Updated when in UTC.
type: string
UpdatedAssociateId:
format: int32
description: Updated by whom
type: integer
UpdatedCount:
format: int32
description: Number of updates made to this record
type: integer
TableRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
FieldProperties:
description: >-
Field property dictionary mapping field names to field access
rights.
type: object
additionalProperties:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
SuperOffice.CRM.Security.TableRight:
description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
type: object
properties:
Mask:
type: string
Reason:
type: string
SuperOffice.CRM.Security.FieldProperty:
description: >-
Class holding properties like field length, field type about a field in
the carrier.
type: object
properties:
FieldRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
FieldType:
type: string
FieldLength:
format: int32
description: ''
type: integer
SuperOffice.CRM.Security.FieldRight:
description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
type: object
properties:
Mask:
type: string
Reason:
type: string
````
## Related topics
- [Get Utm Parameters](/en/api/reference/restful/rest/person/get-utm-parameters.md)
- [SuperOffice.WebApi.Data.Person GetUtmParametersRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person_GetUtmParametersRequest.md)
- [SuperOffice.WebApi.Agents.PersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PersonAgent.md)
- [SuperOffice.WebApi.Agents.IPersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPersonAgent.md)
- [UTM parameters](/en/marketing/utm/learn/parameters.md)
- [utm_parameters table](/en/database/tables/utm-parameters.md)