# Creating an Ingest

To create an Ingest, navigate to the Organization page and in the Ingestion container, choose Set Up Ingestion. Ingests are made up of three components:

Ingestion Format
Timestamp
Name

# Ingestion Format

Aggregations.io currently supports four ingestion formats. Choose the option that fits your event producer:

[
  {
    "eventName": "AppOpen",
    "device": {
      "platform": "iOS",
      "model": "iPhone15,2"
    },
    "app": {
      "version": "1.0",
      "build": 124
    },
    "eventTimestamp": "2023-10-15T03:53:25.459Z"
  },
  {
    "eventName": "AppClose",
    "device": {
      "platform": "iOS",
      "model": "iPhone15,2"
    },
    "app": {
      "version": "1.0",
      "build": 116
    },
    "eventTimestamp": "2023-10-16T21:03:49.46Z"
  }
]

  {"eventName": "AppOpen","device": {"platform": "iOS","model":"iPhone15,2"},"app": {"version":"1.0","build": 124},"eventTimestamp": "2023-10-15T03:53:25.459Z"},
  {"eventName": "AppClose","device": {"platform": "iOS","model":"iPhone15,2"},"app": {"version": "1.0","build": 116},"eventTimestamp": "2023-10-16T21:03:49.46Z"
]

{
  "events": [
    {
      "eventName": "AppOpen",
      "device": {
        "platform": "iOS",
        "model": "iPhone15,2"
      },
      "app": {
        "version": "1.0",
        "build": 124
      },
      "eventTimestamp": "2023-10-15T03:53:25.459Z"
    },
    {
      "eventName": "AppClose",
      "device": {
        "platform": "iOS",
        "model": "iPhone15,2"
      },
      "app": {
        "version": "1.0",
        "build": 116
      },
      "eventTimestamp": "2023-10-16T21:03:49.46Z"
    }
  ]
}

When utilizing this format, you'll need to define where we can find your events within the payload object. You do this using JPath. For the example above, the events property is @.events.

{
    "eventName": "AppOpen",
    "device": {
      "platform": "iOS",
      "model": "iPhone15,2"
    },
    "app": {
      "version": "1.0",
      "build": 124
    },
    "eventTimestamp": "2023-10-15T03:53:25.459Z"
  }

This format isn't recommended unless strictly necessary - as it does not support batching. However some event producers (largely those emitting webhooks) a single object is necessary.

Need a different format? Contact Us

# Timestamps

Choose a timestamp format to serve as the time property for your ingestion. There are two options:

Applies a timestamp based on when the data is received. This is the default option and will work for most use cases.

Allows you to choose a property from your ingested event to use as the timestamp of record using JPath. This option is for use cases such as:

Historical backfills
Time-delayed integrations such as batch services or payment processing providers

Be sure to check out the docs on JPath keys for tips on defining your timestamp property.

# Ingest Name

Ingest names are intended for organizations that need multipe ingests. By default, organizations can only create one ingestion.

Need multiple ingests? Contact Us

# Conclusion

Upon saving your Ingestion, you will receive a POST URL including a unique POST ID that will be used when POSTing events to Aggregations.io's REST Ingest.

You can view and manage your Ingestion details anytime from the Organization page.

After the initial creation, your POST URL and POST will remain costant, even if you edit the Ingestion options.

If you've already setup authentication with API keys, you're ready to start posting events. If not, check out API Keys and get one setup.