SingleSource

GetSingleSourceMeta [finished]

Overlays:

    Activation:

    GetSingleSourceMeta.php

    Description:

        Returns single source statistics meta information.

    Parameters:

    • sessionID: string(16)
    • campaignID: uint

    Results:

    <GetSingleSourceMeta>
        <status>OK</status>
        <campaignID>187190</campaignID>
        <properties>
            <property>
                <id>education</id>
                <name>Education</name>
                <options>
                    <option>
                        <id>elementaryIncompleteSecondary</id>
                        <name>Elementary, incomplete secondary</name>
                    </option>
                    <option>
                        <id>secondary</id>
                        <name>Secondary</name>
                    </option>
                    <option>
                        <id>secondaryVocational</id>
                        <name>Secondary vocational</name>
                    </option>
                    <option>
                        <id>incompleteHigher</id>
                        <name>Incomplete higher</name>
                    </option>
                    <option>
                        <id>higher</id>
                        <name>Higher</name>
                    </option>
                </options>
            </property>
        </properties>
    </GetSingleSourceMeta>

    Throw Errors:



    GetSingleSourceStats [finished]

    Overlays:

      Activation:

      GetSingleSourceStats.php

      Description:

          Returns single source statistics. Use <b>GetSingleSourceMeta</b> command to discover all properties, which can be used as parameters, or dimensions.

      Parameters:

      • sessionID: string(16)
      • campaignID: uint
      • dateFrom: string - 'YYYY-MM-DD'
      • dateTo: string - 'YYYY-MM-DD'
      • indicator: enum('reach', 'realUsers', 'grp', 'frequency', 'adContacts', 'viewableRealUsers', 'viewableReach', 'viewableAdContacts')
      • dimensions: enum('mediaType', 'placement', 'creative', 'mediaType,day', 'placement,day', 'creative,day', 'mediaType,grp', 'newAndReturingUsers,day', 'mediaType,cumulativeRU', 'gender', 'age', 'gender,age')
      • aggregation: enum('value', 'cumulativeValue')
      • minAge: uint
      • maxAge: uint
      • gender: enum('F', 'M')

      Results:

      <GetSingleSourceStats>
          <status>OK</status>
          <campaignID>123</campaignID>
          <targetGroup>
              <minAge>14</minAge>
              <maxAge>69</maxAge>
              <education>
                  elementaryIncompleteSecondary,secondary,secondaryVocational,incompleteHigher,higher
              </education>
              <personalIncome>noIncome</personalIncome>
              <gender>F,M</gender>
              <livingPlace>
                  village,cityUpTo50000Inhabitants,city50000-100000Inhabitants,city100000-500000Inhabitants,Dnipropetrovsk,Donetsk,Zaporizzhya,KyivWithoutRegion,KryvyRih,Lviv,Mykolayiv,Odesa,Kharkiv
              </livingPlace>
              <children>
                  yesChildrenUpTo3yo,yesChildren4-7yo,yesChildren8-12yo,yesChildren13-16yo,yesChildrenOlderThan16yo,noChildren,na
              </children>
          </targetGroup>
          <statistics>
              <statisticsRecord>
                  <mediaType>Total</mediaType>
                  <period>2019-10-11</period>
                  <periodName>Day</periodName>
                  <realUsersReach>0.5317</realUsersReach>
              </statisticsRecord>
              <statisticsRecord>
                  <mediaType>Total</mediaType>
                  <period>2019-10-12</period>
                  <periodName>Day</periodName>
                  <realUsersReach>0.7362</realUsersReach>
              </statisticsRecord>
              <statisticsRecord>
                  <mediaType>TV</mediaType>
                  <period>2019-10-13</period>
                  <periodName>Day</periodName>
                  <realUsersReach>0</realUsersReach>
              </statisticsRecord>
          </statistics>
      </GetSingleSourceStats>

      Throw Errors: